glueby 0.5.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14bc1f60be9eefa4527231fb46fbb0d96b7a2253b1634d94b3a8464290d2ddbb
-  data.tar.gz: b268217f39285ae42fc2a4107bfcb5c32d9a71225e1fbb2b01296d24e62f1a1f
+  metadata.gz: 2b053cde5755947020d018939a4efa0a042e830232aff3e4d2a4a4a9b53caa54
+  data.tar.gz: 5fcfb3f983b687f6942901d7f56c9f70a5123b97e0f5eb313d3a011632824f76
 SHA512:
-  metadata.gz: 5a51e8f38bf391baec903a06e240294e8e75c5a881285f9be369009b77bf6fe9e8fe86fe41f43a1659344a6a38c1fcb3e2293951e8bb1a41d8beb282f63e96f6
-  data.tar.gz: 464fb058d159a083ab096bdb077981b65069e60d1fb73d664d6ea7fb09555c2e0794f4266bb114b5d4d315910f884a3548e6dfd1cd3412c93395f3433a75eaad
+  metadata.gz: 440cd7203e5d411dc0aca3571e2eaa14b2c2ef85ca97d9ed60c7b9099d206dc9d4fbaa4dfb65190ddcc9fc71bbb57555abc42cde5cf2d3319fa4c8c18f3b70cf
+  data.tar.gz: 4dac9b8cb1a8a6670e8ee0458f467c66c91994b103e8d9513bbbfb926c27f9b0541de4bdfe12085edb58b1ac9f761775abf88f3dcb93ab43f9ba17ad0c96f840

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,29 @@ 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] 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)
+        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)
@@ -41,8 +63,20 @@ module Glueby
             end
           end
 
+          prev_txs = if funding_tx
+            output = funding_tx.outputs.first
+            [{
+              txid: funding_tx.txid,
+              vout: 0,
+              scriptPubKey: output.script_pubkey.to_hex,
+              amount: output.value
+            }]
+          else
+            []
+          end
+
           txb.fee(fee).change_address(wallet.internal_wallet.change_address)
-          [funding_tx, wallet.internal_wallet.sign_tx(txb.build)]
+          [funding_tx, wallet.internal_wallet.sign_tx(txb.build, prev_txs), p2c_address, payment_base]
         end
 
         def get_transaction(tx)
@@ -53,6 +87,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
@@ -60,21 +97,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
@@ -84,7 +129,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/internal/wallet/abstract_wallet_adapter.rb

@@ -72,6 +72,8 @@ module Glueby
         # @param [Boolean] only_finalized - The UTXOs includes only finalized UTXO value if it
         #                                   is true. Default is true.
         # @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
         # @return [Array of UTXO]
         #
         # ## The UTXO structure

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

@@ -93,8 +93,15 @@ module Glueby
           wallet = AR::Wallet.find_by(wallet_id: wallet_id)
           utxos = wallet.utxos
           utxos = utxos.where(status: :finalized) if only_finalized
-          utxos = utxos.where(label: label) if label && (label != :unlabeled)
-          utxos = utxos.where(label: nil) if label == :unlabeled
+
+          if [:unlabeled, nil].include?(label)
+            utxos = utxos.where(label: nil)
+          elsif label && (label != :all)
+            utxos = utxos.where(label: label)
+          else
+            utxos
+          end
+
           utxos.map do |utxo|
             {
               txid: utxo.txid,
@@ -102,7 +109,8 @@ module Glueby
               script_pubkey: utxo.script_pubkey,
               color_id: utxo.color_id,
               amount: utxo.value,
-              finalized: utxo.status == 'finalized'
+              finalized: utxo.status == 'finalized',
+              label: utxo.label
             }
           end
         end

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

@@ -82,14 +82,21 @@ module Glueby
           end
         end
 
+        # 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)
           perform_as(wallet_id) do |client|
             min_conf = only_finalized ? 1 : 0
             res = client.listunspent(min_conf)
 
-            res = res.filter { |i| i['label'] == label } if label && (label != :unlabeled)
-            res = res.filter { |i| i['label'] == "" } if label == :unlabeled
- 
+            if [:unlabeled, nil].include?(label)
+              res = res.filter { |i| i['label'] == "" }
+            elsif label && (label != :all)
+              res = res.filter { |i| i['label'] == label }
+            else
+              res
+            end
+
             res.map do |i|
               script = Tapyrus::Script.parse_from_payload(i['scriptPubKey'].htb)
               color_id = if script.cp2pkh? || script.cp2sh?
@@ -101,7 +108,8 @@ module Glueby
                 script_pubkey: i['scriptPubKey'],
                 color_id: color_id,
                 amount: tpc_to_tapyrus(i['amount']),
-                finalized: i['confirmations'] != 0
+                finalized: i['confirmations'] != 0,
+                label: i['label']
               }
             end
           end

data/lib/glueby/internal/wallet.rb

@@ -84,9 +84,10 @@ module Glueby
 
       # @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 not specified (label=nil), all UTXOs will be returned.
-      #                    - If label=:unlabeled, only unlabeled UTXOs will be returned.
-      def list_unspent(only_finalized = true, label = nil)
+      #                    - 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)
+        label = :unlabeled unless label
         wallet_adapter.list_unspent(id, only_finalized, label)
       end
 

data/lib/glueby/version.rb

@@ -1,3 +1,3 @@
 module Glueby
-  VERSION = "0.5.0"
+  VERSION = "0.6.1"
 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.0
+  version: 0.6.1
 platform: ruby
 authors:
 - azuchi
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-22 00:00:00.000000000 Z
+date: 2021-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tapyrus
@@ -147,7 +147,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 +163,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: []