glueby 0.4.4 → 0.6.0

data/glueby.gemspec

@@ -1,33 +1,33 @@
-require_relative 'lib/glueby/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "glueby"
-  spec.version       = Glueby::VERSION
-  spec.authors       = ["azuchi"]
-  spec.email         = ["azuchi@chaintope.com"]
-
-  spec.summary       = %q{A Ruby library of smart contracts that can be used on Tapyrus.}
-  spec.description   = %q{A Ruby library of smart contracts that can be used on Tapyrus.}
-  spec.homepage      = "https://github.com/chaintope/glueby"
-  spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
-
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/chaintope/glueby"
-  spec.metadata["changelog_uri"] = "https://github.com/chaintope/glueby"
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_runtime_dependency 'tapyrus', '>= 0.2.9'
-  spec.add_runtime_dependency 'activerecord', '~> 6.1.3'
-  spec.add_development_dependency 'sqlite3'
-  spec.add_development_dependency 'rails', '~> 6.1.3'
-end
+require_relative 'lib/glueby/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "glueby"
+  spec.version       = Glueby::VERSION
+  spec.authors       = ["azuchi"]
+  spec.email         = ["azuchi@chaintope.com"]
+
+  spec.summary       = %q{A Ruby library of smart contracts that can be used on Tapyrus.}
+  spec.description   = %q{A Ruby library of smart contracts that can be used on Tapyrus.}
+  spec.homepage      = "https://github.com/chaintope/glueby"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/chaintope/glueby"
+  spec.metadata["changelog_uri"] = "https://github.com/chaintope/glueby"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'tapyrus', '>= 0.2.9'
+  spec.add_runtime_dependency 'activerecord', '~> 6.1.3'
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'rails', '~> 6.1.3'
+end

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

@@ -1,8 +1,8 @@
-# Edit configuration for connection to tapyrus core
-Glueby.configure do |config|
-  config.wallet_adapter = :activerecord
-  config.rpc_config = { schema: 'http', host: '127.0.0.1', port: 12381, user: 'user', password: 'pass' }
-end
-
-# Uncomment next line when using timestamp feature
-# Glueby::BlockSyncer.register_syncer(Glueby::Contract::Timestamp::Syncer)
+# Edit configuration for connection to tapyrus core
+Glueby.configure do |config|
+  config.wallet_adapter = :activerecord
+  config.rpc_config = { schema: 'http', host: '127.0.0.1', port: 12381, user: 'user', password: 'pass' }
+end
+
+# Uncomment next line when using timestamp feature
+# Glueby::BlockSyncer.register_syncer(Glueby::Contract::Timestamp::Syncer)

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

@@ -1,16 +1,16 @@
-class CreateKey < ActiveRecord::Migration<%= migration_version %>
-  def change
-    create_table :glueby_keys<%= table_options %> do |t|
-      t.string     :private_key
-      t.string     :public_key
-      t.string     :script_pubkey
-      t.string     :label, index: true
-      t.integer    :purpose
-      t.belongs_to :wallet
-      t.timestamps
-    end
-
-    add_index :glueby_keys, [:script_pubkey], unique: true
-    add_index :glueby_keys, [:private_key], unique: true
-  end
-end
+class CreateKey < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :glueby_keys<%= table_options %> do |t|
+      t.string     :private_key
+      t.string     :public_key
+      t.string     :script_pubkey
+      t.string     :label, index: true
+      t.integer    :purpose
+      t.belongs_to :wallet
+      t.timestamps
+    end
+
+    add_index :glueby_keys, [:script_pubkey], unique: true
+    add_index :glueby_keys, [:private_key], unique: true
+  end
+end

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/generators/glueby/contract/templates/utxo_table.rb.erb

@@ -1,16 +1,16 @@
-class CreateUtxo < ActiveRecord::Migration<%= migration_version %>
-  def change
-    create_table :glueby_utxos<%= table_options %> do |t|
-      t.string     :txid
-      t.integer    :index
-      t.bigint     :value
-      t.string     :script_pubkey
-      t.string     :label, index: true
-      t.integer    :status
-      t.belongs_to :key, null: true
-      t.timestamps
-    end
-
-    add_index :glueby_utxos, [:txid, :index], unique: true
-  end
-end
+class CreateUtxo < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :glueby_utxos<%= table_options %> do |t|
+      t.string     :txid
+      t.integer    :index
+      t.bigint     :value
+      t.string     :script_pubkey
+      t.string     :label, index: true
+      t.integer    :status
+      t.belongs_to :key, null: true
+      t.timestamps
+    end
+
+    add_index :glueby_utxos, [:txid, :index], unique: true
+  end
+end

data/lib/glueby/block_syncer.rb

@@ -1,98 +1,98 @@
-module Glueby
-  # You can use BlockSyncer when you need to synchronize the state of
-  # an application with the state of a blockchain. When BlockSyncer
-  # detects the generation of a new block, it executes the registered
-  # syncer code on a block-by-block or transaction-by-transaction basis.
-  # By using this, an application can detect that the issued transaction
-  # has been captured in  blocks, receive a new remittance, and so on.
-  #
-  # # Syncer logic registration
-  #
-  # For registration, create a class that implements the method that performs
-  # synchronization processing and registers it in BlockSyncer. Implement
-  # methods with the following name in that class.
-  #
-  # Method name        | Arguments             | Call conditions
-  # ------------------ | --------------------- | ------------------------------
-  # block_sync (block) | block: Tapyrus::Block | When a new block is created
-  # block_tx (tx)      | tx: Tapyrus::Tx       | When a new block is created, it is executed for each tx contained in that block.
-  #
-  # @example Register a synchronous logic
-  #   class Syncer
-  #     def block_sync (block)
-  #       # sync a block
-  #     end
-  #
-  #     def tx_sync (tx)
-  #       # sync a tx
-  #     end
-  #   end
-  #   BlockSyncer.register_syncer(Syncer)
-  #
-  # @example Unregister the synchronous logic
-  #   BlockSyncer.unregister_syncer(Syncer)
-  #
-  # # Run BlockSyncer
-  #
-  # Run the `glueby: block_syncer: start` rake task periodically with a program
-  # for periodic execution such as cron. If it detects the generation of a new
-  # block when it is executed, the synchronization process will be executed.
-  # Determine the execution interval according to the requirements of the application.
-  class BlockSyncer
-    # @!attribute [r] height
-    #   @return [Integer] The block height to be synced
-    attr_reader :height
-
-    class << self
-      # @!attribute r syncers
-      #   @return [Array<Class>] The syncer classes that is registered
-      attr_reader :syncers
-
-      # Register syncer class
-      # @param [Class] syncer The syncer to be registered.
-      def register_syncer(syncer)
-        @syncers ||= []
-        @syncers << syncer
-      end
-
-      # Unregister syncer class
-      # @param [Class] syncer The syncer to be unregistered.
-      def unregister_syncer(syncer)
-        @syncers ||= []
-        @syncers.delete(syncer)
-      end
-    end
-
-    # @param [Integer] height The block height to be synced in the instance
-    def initialize(height)
-      @height = height
-    end
-
-    # Run a block synchronization
-    def run
-      return if self.class.syncers.nil?
-
-      self.class.syncers.each do |syncer|
-        instance = syncer.new
-        instance.block_sync(block) if instance.respond_to?(:block_sync)
-
-        if instance.respond_to?(:tx_sync)
-          block.transactions.each { |tx| instance.tx_sync(tx) }
-        end
-      end
-    end
-
-    private
-
-    def block
-      @block ||= begin
-                   block = Glueby::Internal::RPC.client.getblock(block_hash, 0)
-                   Tapyrus::Block.parse_from_payload(block.htb)
-                 end
-    end
-
-    def block_hash
-      @block_hash ||= Glueby::Internal::RPC.client.getblockhash(height)
-    end
-  end
+module Glueby
+  # You can use BlockSyncer when you need to synchronize the state of
+  # an application with the state of a blockchain. When BlockSyncer
+  # detects the generation of a new block, it executes the registered
+  # syncer code on a block-by-block or transaction-by-transaction basis.
+  # By using this, an application can detect that the issued transaction
+  # has been captured in  blocks, receive a new remittance, and so on.
+  #
+  # # Syncer logic registration
+  #
+  # For registration, create a class that implements the method that performs
+  # synchronization processing and registers it in BlockSyncer. Implement
+  # methods with the following name in that class.
+  #
+  # Method name        | Arguments             | Call conditions
+  # ------------------ | --------------------- | ------------------------------
+  # block_sync (block) | block: Tapyrus::Block | When a new block is created
+  # block_tx (tx)      | tx: Tapyrus::Tx       | When a new block is created, it is executed for each tx contained in that block.
+  #
+  # @example Register a synchronous logic
+  #   class Syncer
+  #     def block_sync (block)
+  #       # sync a block
+  #     end
+  #
+  #     def tx_sync (tx)
+  #       # sync a tx
+  #     end
+  #   end
+  #   BlockSyncer.register_syncer(Syncer)
+  #
+  # @example Unregister the synchronous logic
+  #   BlockSyncer.unregister_syncer(Syncer)
+  #
+  # # Run BlockSyncer
+  #
+  # Run the `glueby: block_syncer: start` rake task periodically with a program
+  # for periodic execution such as cron. If it detects the generation of a new
+  # block when it is executed, the synchronization process will be executed.
+  # Determine the execution interval according to the requirements of the application.
+  class BlockSyncer
+    # @!attribute [r] height
+    #   @return [Integer] The block height to be synced
+    attr_reader :height
+
+    class << self
+      # @!attribute r syncers
+      #   @return [Array<Class>] The syncer classes that is registered
+      attr_reader :syncers
+
+      # Register syncer class
+      # @param [Class] syncer The syncer to be registered.
+      def register_syncer(syncer)
+        @syncers ||= []
+        @syncers << syncer
+      end
+
+      # Unregister syncer class
+      # @param [Class] syncer The syncer to be unregistered.
+      def unregister_syncer(syncer)
+        @syncers ||= []
+        @syncers.delete(syncer)
+      end
+    end
+
+    # @param [Integer] height The block height to be synced in the instance
+    def initialize(height)
+      @height = height
+    end
+
+    # Run a block synchronization
+    def run
+      return if self.class.syncers.nil?
+
+      self.class.syncers.each do |syncer|
+        instance = syncer.new
+        instance.block_sync(block) if instance.respond_to?(:block_sync)
+
+        if instance.respond_to?(:tx_sync)
+          block.transactions.each { |tx| instance.tx_sync(tx) }
+        end
+      end
+    end
+
+    private
+
+    def block
+      @block ||= begin
+                   block = Glueby::Internal::RPC.client.getblock(block_hash, 0)
+                   Tapyrus::Block.parse_from_payload(block.htb)
+                 end
+    end
+
+    def block_hash
+      @block_hash ||= Glueby::Internal::RPC.client.getblockhash(height)
+    end
+  end
 end

data/lib/glueby/configuration.rb

@@ -10,11 +10,17 @@ module Glueby
   #     end
   class Configuration
 
-    attr_reader :fee_provider_bears
+    attr_reader :fee_provider_bears, :use_utxo_provider
     alias_method :fee_provider_bears?, :fee_provider_bears
+    alias_method :use_utxo_provider?, :use_utxo_provider
+
+    module Errors
+      class InvalidConfiguration < StandardError; end
+    end
 
     def initialize
       @fee_provider_bears = false
+      @use_utxo_provider = false
     end
 
     # Specify wallet adapter.
@@ -54,9 +60,33 @@ module Glueby
     # Specify FeeProvider configuration.
     # @param [Hash] config
     # @option config [Integer] :fixed_fee - The fee that Fee Provider pays on each transaction.
-    # @option config [Integer] :utxo_pool_size - Fee Provider tries to keep the number of utxo in utxo pool as this size using `glueby:fee_provider:manage_utxo_pool` rake task
+    # @option config [Integer] :utxo_pool_size - Fee Provider tries to keep the number of utxo in utxo pool as this size using `glueby:fee_provider:manage_utxo_pool` rake task. this size should not be greater than 2000.
     def fee_provider_config=(config)
       FeeProvider.configure(config)
     end
+
+    # Enable UtxoProvider feature
+    def enable_utxo_provider!
+      @use_utxo_provider = true
+    end
+
+    # Disable UtxoProvider feature
+    def disable_utxo_provider!
+      @use_utxo_provider = false
+    end
+
+    # Set UtxoProvider configuration
+    # @param [Hash] config
+    # @option config [Integer] :default_value - The fee that Fee Provider pays on each transaction.
+    # @option config [Integer] :utxo_pool_size - Utxo Provider tries to keep the number of utxo in utxo pool as this size using `glueby:utxo_provider:manage_utxo_pool` rake task. this size should not be greater than 2000.
+    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,17 @@ 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
       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/syncer.rb

@@ -1,13 +1,13 @@
-module Glueby
-  module Contract
-    class Timestamp
-      class Syncer
-        def block_sync(block)
-          Glueby::Contract::AR::Timestamp
-            .where(txid: block.transactions.map(&:txid), status: :unconfirmed)
-            .update_all(status: :confirmed)
-        end
-      end
-    end
-  end
-end
+module Glueby
+  module Contract
+    class Timestamp
+      class Syncer
+        def block_sync(block)
+          Glueby::Contract::AR::Timestamp
+            .where(txid: block.transactions.map(&:txid), status: :unconfirmed)
+            .update_all(status: :confirmed)
+        end
+      end
+    end
+  end
+end