glueby 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 660935ed3cb303d6c9f73b27fffd978f048365e60b701b598b0fa0384ceff8ad
-  data.tar.gz: 02d01a50fb301290ee693eb02b9592d193f6a8a10b5fb4cbb5419bc1ab01a41a
+  metadata.gz: feaf2f20c90016badb4f10ca4028c87567f204cdfcdf2dee7d68a7dddbe1af8a
+  data.tar.gz: a7a68472e21a22901b9a1a1d42b12d77c5e12a86cb6086f1fd7d0dd9dafde7b2
 SHA512:
-  metadata.gz: efc0bed86713965cc63cd747fc4477a825ff9e715ef9d95c5dfed1c42b2622e090cc3d3d85f1feef715bc497081269c2315c683bf8b0c9d90b975b04b310f69a
-  data.tar.gz: 3c2c5295abd8782850eaa1a901b44d901eaf088d3666eab918ce43992e5c5a9c5091583147511d8cfd5286351de8095eae2f4ae1163386088578717b2a199da7
+  metadata.gz: 9bc1d2d57bbb1e928b30ffefb0d3ae383c9832d0293b5987b74c3ee8cae17466ada78bc0dc60096ee76212e455e12badaee1be80741ffe4f59c79191d1bed67b
+  data.tar.gz: 89d17b7f01272bd5bfabe47cba0a8b776ad6ff1932de3eecdd61372da2ab89cbe3eb0410661d22aaa1743be0a58b023f97ab64503653e9cac11d56fb71c6b93f

data/.github/workflows/ruby.yml

@@ -18,16 +18,15 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ["2.6", "2.7", "3.0"]
+        ruby-version: ["2.6", "2.7", "3.0", "3.1"]
 
     steps:
-      - run: docker pull tapyrus/tapyrusd:edge
+      - run: docker pull tapyrus/tapyrusd:v0.5.1
       - uses: actions/checkout@v2
       - name: Set up Ruby
         # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
         # change this to (see https://github.com/ruby/setup-ruby#versioning):
-        # uses: ruby/setup-ruby@v1
-        uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+        uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby-version }}
           bundler-cache: true # runs 'bundle install' and caches installed gems automatically

data/README.md

@@ -72,7 +72,7 @@ Or install it yourself as:
 
     Starts tapryusd container
 
-        $ docker run -d --name 'tapyrus_node_dev' -p 12381:12381 -e GENESIS_BLOCK_WITH_SIG='0100000000000000000000000000000000000000000000000000000000000000000000002b5331139c6bc8646bb4e5737c51378133f70b9712b75548cb3c05f9188670e7440d295e7300c5640730c4634402a3e66fb5d921f76b48d8972a484cc0361e66ef74f45e012103af80b90d25145da28c583359beb47b21796b2fe1a23c1511e443e7a64dfdb27d40e05f064662d6b9acf65ae416379d82e11a9b78cdeb3a316d1057cd2780e3727f70a61f901d10acbe349cd11e04aa6b4351e782c44670aefbe138e99a5ce75ace01010000000100000000000000000000000000000000000000000000000000000000000000000000000000ffffffff0100f2052a010000001976a91445d405b9ed450fec89044f9b7a99a4ef6fe2cd3f88ac00000000' tapyrus/tapyrusd:edge
+        $ docker run -d --name 'tapyrus_node_dev' -p 12381:12381 -e GENESIS_BLOCK_WITH_SIG='0100000000000000000000000000000000000000000000000000000000000000000000002b5331139c6bc8646bb4e5737c51378133f70b9712b75548cb3c05f9188670e7440d295e7300c5640730c4634402a3e66fb5d921f76b48d8972a484cc0361e66ef74f45e012103af80b90d25145da28c583359beb47b21796b2fe1a23c1511e443e7a64dfdb27d40e05f064662d6b9acf65ae416379d82e11a9b78cdeb3a316d1057cd2780e3727f70a61f901d10acbe349cd11e04aa6b4351e782c44670aefbe138e99a5ce75ace01010000000100000000000000000000000000000000000000000000000000000000000000000000000000ffffffff0100f2052a010000001976a91445d405b9ed450fec89044f9b7a99a4ef6fe2cd3f88ac00000000' tapyrus/tapyrusd:v0.5.1
 
 4. Modify the glueby configuration
 
@@ -93,9 +93,9 @@ Or install it yourself as:
         $ rails g glueby:contract:block_syncer
         $ rails g glueby:contract:wallet_adapter
 
-    If you want to use reissuable token or timestamp, you need to do below generators.
+    If you want to use token or timestamp, you need to do below generators.
 
-        $ rails g glueby:contract:reissuable_token
+        $ rails g glueby:contract:token
         $ rails g glueby:contract:timestamp
 
     Then, run the migrations.

data/glueby.gemspec

@@ -26,8 +26,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency 'tapyrus', '>= 0.2.13'
+  spec.add_runtime_dependency 'tapyrus', '>= 0.3.1'
   spec.add_runtime_dependency 'activerecord', '~> 6.1.3'
   spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'mysql2'
   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

@@ -7,6 +7,8 @@ class CreateTimestamp < ActiveRecord::Migration<%= migration_version %>
       t.string   :prefix
       t.string   :wallet_id
       t.integer  :timestamp_type, null: false, default: 0
+      t.integer :block_height, index: true
+      t.integer :block_time, index: true
       t.string   :p2c_address
       t.string   :payment_base
       t.bigint   :prev_id

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

@@ -0,0 +1,13 @@
+class CreateTokenMetadata < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :glueby_token_metadata<%= table_options %> do |t|
+      t.text     :metadata, null: false
+      t.string   :color_id, null: false
+      t.string   :p2c_address, null: false
+      t.string   :payment_base, null: false
+      t.timestamps
+    end
+
+    add_index :glueby_token_metadata, [:color_id], unique: true
+  end
+end

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

@@ -7,6 +7,7 @@ class CreateUtxo < ActiveRecord::Migration<%= migration_version %>
       t.string     :script_pubkey
       t.string     :label, index: true
       t.integer    :status
+      t.datetime   :locked_at
       t.belongs_to :key, null: true
       t.timestamps
     end

data/lib/generators/glueby/contract/{reissuable_token_generator.rb → token_generator.rb}

@@ -1,6 +1,6 @@
 module Glueby
   module Contract
-    class ReissuableTokenGenerator < Rails::Generators::Base
+    class TokenGenerator < Rails::Generators::Base
       include ::Rails::Generators::Migration
       include Glueby::Generator::MigrateGenerator
       extend Glueby::Generator::MigrateGenerator::ClassMethod
@@ -10,6 +10,17 @@ module Glueby
       def create_migration_file
         migration_dir = File.expand_path("db/migrate")
 
+        if self.class.migration_exists?(migration_dir, "create_token_metadata")
+          ::Kernel.warn "Migration already exists: create_token_metadata"
+        else
+          migration_template(
+            "token_metadata_table.rb.erb",
+            "db/migrate/create_token_metadata.rb",
+            migration_version: migration_version,
+            table_options: table_options,
+          )
+        end
+
         if self.class.migration_exists?(migration_dir, "create_reissuable_token")
           ::Kernel.warn "Migration already exists: create_reissuable_token"
         else

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

@@ -31,6 +31,8 @@ module Glueby
         Glueby::Internal::Wallet.wallet_adapter = Glueby::Internal::Wallet::TapyrusCoreWalletAdapter.new
       when :activerecord
         Glueby::Internal::Wallet.wallet_adapter = Glueby::Internal::Wallet::ActiveRecordWalletAdapter.new
+      when :mysql
+        Glueby::Internal::Wallet.wallet_adapter = Glueby::Internal::Wallet::MySQLWalletAdapter.new
       else
         raise 'Not implemented'
       end

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

@@ -94,7 +94,7 @@ module Glueby
         # @raise [Glueby::Contract::Errors::PrevTimestampAlreadyUpdated] If the previous timestamp was already updated
         def save_with_broadcast!(fee_estimator: Glueby::Contract::FeeEstimator::Fixed.new, utxo_provider: nil)
           validate_prev!
-          utxo_provider = Glueby::UtxoProvider.new if !utxo_provider && Glueby.configuration.use_utxo_provider?
+          utxo_provider = Glueby::UtxoProvider.instance if !utxo_provider && Glueby.configuration.use_utxo_provider?
 
           funding_tx, tx, p2c_address, payment_base = create_txs(fee_estimator, utxo_provider)
 
@@ -121,6 +121,7 @@ module Glueby
         rescue Tapyrus::RPC::Error,
                Internal::Wallet::Errors::WalletAlreadyLoaded,
                Internal::Wallet::Errors::WalletNotFound,
+               Glueby::Internal::Wallet::Errors::InvalidSigner,
                Errors::InsufficientFunds => e
           errors.add(:base, "failed to broadcast (id=#{id}, reason=#{e.message})")
           raise Errors::FailedToBroadcast, "failed to broadcast (id=#{id}, reason=#{e.message})"
@@ -175,7 +176,7 @@ module Glueby
         def validate_prev
           validate_prev!
           true
-        rescue Errors::ArgumentError
+        rescue Errors::ArgumentError, Glueby::Internal::Wallet::Errors::InvalidSigner
           false
         end
 
@@ -205,6 +206,12 @@ module Glueby
             errors.add(:prev_id, message)
             raise Errors::PrevTimestampAlreadyUpdated, message
           end
+
+          if prev.wallet_id != wallet_id
+            message = "The previous timestamp(id: #{prev_id}) was created by the different user"
+            errors.add(:prev_id, message)
+            raise Glueby::Internal::Wallet::Errors::InvalidSigner, message
+          end
         end
       end
     end

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

@@ -0,0 +1,8 @@
+module Glueby
+  module Contract
+    module AR
+      class TokenMetadata < ::ActiveRecord::Base
+      end
+    end
+  end
+end

data/lib/glueby/contract/active_record.rb

@@ -4,6 +4,7 @@ module Glueby
   module Contract
     module AR
       autoload :ReissuableToken, 'glueby/contract/active_record/reissuable_token'
+      autoload :TokenMetadata, 'glueby/contract/active_record/token_metadata'
       autoload :Timestamp, 'glueby/contract/active_record/timestamp'
     end
   end

data/lib/glueby/contract/fee_estimator/auto.rb

@@ -26,7 +26,15 @@ module Glueby
         private
 
         def estimate_fee(tx)
-          ((tx.to_payload.bytesize / 1000.0) * fee_rate).ceil
+          fee = ((tx.size / 1000.0) * fee_rate).ceil
+
+          # TODO: Eliminate the below block after https://github.com/chaintope/tapyrus-core/issues/191 will be done.
+          if tx.outputs.find(&:colored?)
+            # Tapyrus Core requires more over 1 from the just amount fee if the tx has colored outputs
+            fee + 1
+          else
+            fee
+          end
         end
       end
     end

data/lib/glueby/contract/fee_estimator.rb

@@ -11,17 +11,24 @@ module Glueby
         estimate_fee(tx)
       end
 
-      # Add dummy inputs and outputs to tx
-      def dummy_tx(tx)
+      # Add dummy inputs and outputs to tx.
+      # Fee Estimation needs the actual tx size when it will be broadcasted to the blockchain network.
+      #
+      # @param [Tapyrus::Tx] tx The tx that is the target to be estimated fees
+      # @param [Integer] dummy_input_count The number of dummy inputs to be added before the estimation.
+      # @return [Tapyrus::Tx]
+      def dummy_tx(tx, dummy_input_count: 1)
         dummy = Tapyrus::Tx.parse_from_payload(tx.to_payload)
 
         # dummy input for tpc
-        out_point = Tapyrus::OutPoint.new('00' * 32, 0)
-        dummy.inputs << Tapyrus::TxIn.new(out_point: out_point)
+        dummy_input_count.times do
+          out_point = Tapyrus::OutPoint.new('00' * 32, 0)
+          dummy.inputs << Tapyrus::TxIn.new(out_point: out_point)
+        end
 
         # Add script_sig to all intpus
         dummy.inputs.each do |input|
-          input.script_sig = Tapyrus::Script.parse_from_payload('000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000'.htb)
+          input.script_sig = Tapyrus::Script.parse_from_payload(('00' * 100).htb)
         end
 
         # dummy output to return change

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

@@ -5,7 +5,7 @@ module Glueby
         def block_sync(block)
           Glueby::Contract::AR::Timestamp
             .where(txid: block.transactions.map(&:txid), status: :unconfirmed)
-            .update_all(status: :confirmed)
+            .update_all(status: :confirmed, block_height: block.height, block_time: block.header.time)
         end
       end
     end