glueby 1.1.2 → 1.2.0.beta.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf5bddcac51622b30df3af390b3755b5f98509cb890a4d7505b60bc08b44f896
-  data.tar.gz: 7e456329486fe6f1bef94899827c59a56ae9f6e327fc6149170cb84adb104965
+  metadata.gz: 7615df66be0078e89e4ed0aedd30bcfdb45b86ad9eac3c67fd9d6b65b93e9276
+  data.tar.gz: ca247aec2c3951be9b294055d43dbe042bebd1d435d5e05dd763e11152bc355b
 SHA512:
-  metadata.gz: '0849f5053fe790bbdbeb4e81829ced6597af38c9dea55c94ab07c2d1e7ce767f064a607451b575d30f5fd2cad8e2155d9de300dfdca9f72abaf0f62f446831a1'
-  data.tar.gz: e1513b7c30d6a3b1c807b3150d4b22c46615fa41167cc2b0e33a14489599811b71cfef5c875e2fdf98ed4ec6f73c360e41b4250787be66371e74bfc2de843c39
+  metadata.gz: 92d9640a75627b4513729a96b870d7b056a1f09ef5716bbcc708a6bc60b04ceea786963569792810a40acceb5f8e2eeb318a07a059b4d1e7e606f83119b68919
+  data.tar.gz: f035ad6414ae3bf17a8cab97ea1c90a5ab3effbd9e876165151a786846080a619c979bc8f211371488adf4d383d5c5719235c9ece38c07949d8db0c2623ccfe2

data/.github/workflows/ruby.yml

@@ -9,19 +9,19 @@ name: Ruby
 
 on:
   push:
-    branches: [master, v1.1]
+    branches: [master, v1.1, v1.2]
   pull_request:
-    branches: [master, v1.1]
+    branches: [master, v1.1, v1.2]
 
 jobs:
   test:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ["2.6", "2.7", "3.0", "3.1"]
+        ruby-version: ["2.7", "3.0", "3.1", "3.2"]
 
     steps:
-      - run: docker pull tapyrus/tapyrusd:v0.5.1
+      - run: docker pull tapyrus/tapyrusd:v0.5.2
       - uses: actions/checkout@v2
       - name: Set up Ruby
         # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,

data/.ruby-version

@@ -1 +1 @@
-ruby-3.0.0
+ruby-3.2.2

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:v0.5.1
+        $ docker run -d --name 'tapyrus_node_dev' -p 12381:12381 -e GENESIS_BLOCK_WITH_SIG='0100000000000000000000000000000000000000000000000000000000000000000000002b5331139c6bc8646bb4e5737c51378133f70b9712b75548cb3c05f9188670e7440d295e7300c5640730c4634402a3e66fb5d921f76b48d8972a484cc0361e66ef74f45e012103af80b90d25145da28c583359beb47b21796b2fe1a23c1511e443e7a64dfdb27d40e05f064662d6b9acf65ae416379d82e11a9b78cdeb3a316d1057cd2780e3727f70a61f901d10acbe349cd11e04aa6b4351e782c44670aefbe138e99a5ce75ace01010000000100000000000000000000000000000000000000000000000000000000000000000000000000ffffffff0100f2052a010000001976a91445d405b9ed450fec89044f9b7a99a4ef6fe2cd3f88ac00000000' tapyrus/tapyrusd:v0.5.2
 
 4. Modify the glueby configuration
 

data/glueby.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   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.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 
 
   spec.metadata["homepage_uri"] = spec.homepage
@@ -27,8 +27,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency 'tapyrus', '>= 0.3.1'
-  spec.add_runtime_dependency 'activerecord', '~> 6.1.3'
+  spec.add_runtime_dependency 'activerecord', '~> 7.0.0'
   spec.add_development_dependency 'sqlite3'
   spec.add_development_dependency 'mysql2'
-  spec.add_development_dependency 'rails', '~> 6.1.3'
+  spec.add_development_dependency 'rails', '~> 7.0.0'
 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/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/contract/active_record/timestamp.rb

@@ -99,9 +99,6 @@ module Glueby
           funding_tx, tx, p2c_address, payment_base = create_txs(fee_estimator, utxo_provider)
 
           if funding_tx
-            ::ActiveRecord::Base.transaction(joinable: false, requires_new: true) do
-              wallet.internal_wallet.broadcast(funding_tx)
-            end
             logger.info("funding tx was broadcasted(id=#{id}, funding_tx.txid=#{funding_tx.txid})")
           end
           ::ActiveRecord::Base.transaction(joinable: false, requires_new: true) do

data/lib/glueby/contract/payment.rb

@@ -29,28 +29,23 @@ module Glueby
     # => 10_000
     #
     class Payment
-      extend Glueby::Contract::TxBuilder
-
       class << self
         def transfer(sender:, receiver_address:, amount:, fee_estimator: FeeEstimator::Fixed.new)
           raise Glueby::Contract::Errors::InvalidAmount unless amount.positive?
 
-          tx = Tapyrus::Tx.new
-          dummy_fee = fee_estimator.fee(FeeEstimator.dummy_tx(tx))
-
-          sum, outputs = sender.internal_wallet.collect_uncolored_outputs(dummy_fee + amount)
-          fill_input(tx, outputs)
-
-          receiver_script = Tapyrus::Script.parse_from_addr(receiver_address)
-          tx.outputs << Tapyrus::TxOut.new(value: amount, script_pubkey: receiver_script)
-
-          fee = fee_estimator.fee(tx)
+          txb = Internal::ContractBuilder.new(
+            sender_wallet: sender.internal_wallet,
+            fee_estimator: fee_estimator
+          )
 
-          fill_change_tpc(tx, sender, sum - fee - amount)
+          _sum, outputs = sender.internal_wallet.collect_uncolored_outputs(txb.dummy_fee + amount)
+          outputs.each do |utxo|
+            txb.add_utxo(utxo)
+          end
 
-          tx = sender.internal_wallet.sign_tx(tx)
+          txb.pay(receiver_address, amount)
 
-          sender.internal_wallet.broadcast(tx)
+          sender.internal_wallet.broadcast(txb.build)
         end
       end
     end

data/lib/glueby/contract/timestamp/tx_builder/simple.rb

@@ -4,21 +4,18 @@ module Glueby
       module TxBuilder
         # The simple Timestamp method
         class Simple
-          include Glueby::Contract::TxBuilder
-
-          attr_reader :funding_tx
-
           def initialize(wallet, fee_estimator)
             @wallet = wallet
             @fee_estimator = fee_estimator
 
-            @txb = Tapyrus::TxBuilder.new
-            @prev_txs = []
+            @txb = Internal::ContractBuilder.new(
+              sender_wallet: @wallet.internal_wallet,
+              fee_estimator: @fee_estimator
+            )
           end
 
           def build
-            @txb.fee(fee).change_address(@wallet.internal_wallet.change_address)
-            sign_tx
+            @txb.build
           end
 
           def set_data(prefix, data)
@@ -35,64 +32,29 @@ module Glueby
 
           def set_inputs(utxo_provider)
             if utxo_provider
-              script_pubkey = Tapyrus::Script.parse_from_addr(@wallet.internal_wallet.receive_address)
-              @funding_tx, index = utxo_provider.get_utxo(script_pubkey, fee)
-
-              utxo = {
-                script_pubkey: @funding_tx.outputs[index].script_pubkey.to_hex,
-                txid: @funding_tx.txid,
-                vout: index,
-                amount: funding_tx.outputs[index].value
-              }
-
-              @txb.add_utxo(to_tapyrusrb_utxo_hash(utxo))
-              @prev_txs << to_sign_tx_utxo_hash(utxo)
+              @txb.add_utxo_to!(
+                address: @wallet.internal_wallet.receive_address,
+                amount: input_amount,
+                utxo_provider: utxo_provider
+              )
             else
+              fee = input_amount
+              return self if fee == 0
+
               _, outputs = @wallet.internal_wallet.collect_uncolored_outputs(fee)
-              outputs.each do |utxo|
-                @txb.add_utxo(to_tapyrusrb_utxo_hash(utxo))
-              end
+              outputs.each { |utxo| @txb.add_utxo(utxo) }
             end
             self
           end
 
-          private
-
-          def fee
-            @fee ||= @fee_estimator.fee(FeeEstimator.dummy_tx(@txb.build))
-          end
-
-          def sign_tx
-            # General signing process skips signing to p2c inputs because no key of the p2c address in the wallet.
-            @wallet.internal_wallet.sign_tx(@txb.build, @prev_txs)
+          def funding_tx
+            @txb.prev_txs.first
           end
 
-          # @param utxo
-          # @option utxo [String] :txid The txid
-          # @option utxo [Integer] :vout The index of the output in the tx
-          # @option utxo [Integer] :amount The value of the output
-          # @option utxo [String] :script_pubkey The hex string of the script pubkey
-          def to_tapyrusrb_utxo_hash(utxo)
-            {
-              script_pubkey: Tapyrus::Script.parse_from_payload(utxo[:script_pubkey].htb),
-              txid: utxo[:txid],
-              index: utxo[:vout],
-              value: utxo[:amount]
-            }
-          end
+          private
 
-          # @param utxo
-          # @option utxo [String] :txid The txid
-          # @option utxo [Integer] :vout The index of the output in the tx
-          # @option utxo [Integer] :amount The value of the output
-          # @option utxo [String] :script_pubkey The hex string of the script pubkey
-          def to_sign_tx_utxo_hash(utxo)
-            {
-              scriptPubKey: utxo[:script_pubkey],
-              txid: utxo[:txid],
-              vout: utxo[:vout],
-              amount: utxo[:amount]
-            }
+          def input_amount
+            @txb.dummy_fee
           end
         end
       end

data/lib/glueby/contract/timestamp/tx_builder/trackable.rb

@@ -16,6 +16,12 @@ module Glueby
             @txb.pay(p2c_address, P2C_DEFAULT_VALUE)
             self
           end
+
+          private
+
+          def input_amount
+            super + P2C_DEFAULT_VALUE
+          end
         end
       end
     end

data/lib/glueby/contract/timestamp/tx_builder/updating_trackable.rb

@@ -8,11 +8,12 @@ module Glueby
             @prev_payment_base = payment_base
             @prev_prefix = prefix
             @prev_data = data
-            @txb.add_utxo(to_tapyrusrb_utxo_hash(@prev_timestamp_utxo))
+            @txb.add_utxo(@prev_timestamp_utxo)
           end
 
-          def sign_tx
+          def build
             tx = super
+
             # Generates signature for the remain p2c input.
             @wallet.internal_wallet.sign_to_pay_to_contract_address(
               tx,