scale_rb 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79d55aeb610c1a4a11410703445983aa6b02cbf8ee21653a38d425b06c41e3dc
-  data.tar.gz: 8e7832aa2495fed7226797bd21bc23db257754c8d5160cba57f7830879fe592f
+  metadata.gz: e5b8734ff8c6eda16208a8bb532ee411e15eaf04bf53f5f0f4d8465724b5f89e
+  data.tar.gz: 4aabf928980af1c7d2c6db2857c832743a9288f4e5b7cd17007ce6c25d7def1f
 SHA512:
-  metadata.gz: 879a524038c25c42b98724a95c9db2658ba41a952386fa4132eb56ceff4d3403aa3fc519c4add1d29fc1ad6e413bdb5f1bc8ab4585a836327bc233dc7750ab43
-  data.tar.gz: 4529731208f640854a9b9b3676ffdd3727b9344833ab026cd593f5d10e17ea0428bd651bc01aa774cb80fd68350249ba68be4b99eea54db6fe597b6f3732723a
+  metadata.gz: 2645dc18deb5d1d95bb28a4ad89512d2a05e9651f19eb48c3090895ab8fa16795204d09dbef9214168ba03126f0f2e6251e654b1bfb9766f12a3d85fc8801af1
+  data.tar.gz: 0ffb2cf53f4e46014f624f5e7d6d60cb8f92a9dabc74c97b90bf26725c3a6a80ffae96408df6aa0d4295d8ecef80b0f5520c74acb3f63a14d218084d48dd1abb

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    scale_rb (0.3.0)
+    scale_rb (0.3.1)
       async
       async-http (~> 0.69.0)
       async-websocket (~> 0.26.2)
@@ -12,7 +12,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    async (2.14.0)
+    async (2.14.1)
       console (~> 1.25, >= 1.25.2)
       fiber-annotation
       io-event (~> 1.6, >= 1.6.5)
@@ -45,7 +45,7 @@ GEM
     fiber-local (1.1.0)
       fiber-storage
     fiber-storage (0.1.2)
-    io-endpoint (0.11.0)
+    io-endpoint (0.13.0)
     io-event (1.6.5)
     io-stream (0.4.0)
     json (2.7.2)

data/examples/ws_client_1.rb

@@ -1,14 +1,10 @@
 require 'scale_rb'
 
-ScaleRb.logger.level = Logger::DEBUG
+# ScaleRb.logger.level = Logger::DEBUG
 
-# the commented code below is the same as the code above
 ScaleRb::WsClient.start('wss://polkadot-rpc.dwellir.com') do |client|
   block_hash = client.chain_getBlockHash(21585684)
-  # block_hash = client.request('chain_getBlockHash', [21585684])
-
   runtime_version = client.state_getRuntimeVersion(block_hash)
-  # runtime_version = client.request('state_getRuntimeVersion', [block_hash])
-
-  puts runtime_version
+  puts runtime_version['specName']
+  puts runtime_version['specVersion']
 end

data/examples/ws_client_3.rb

@@ -1,6 +1,6 @@
 require 'scale_rb'
 
-ScaleRb.logger.level = Logger::DEBUG
+# ScaleRb.logger.level = Logger::DEBUG
 
 ScaleRb::WsClient.start('wss://polkadot-rpc.dwellir.com') do |client|
   count = 0
@@ -13,7 +13,8 @@ ScaleRb::WsClient.start('wss://polkadot-rpc.dwellir.com') do |client|
       block_hash = client.chain_getBlockHash(block_number)
       puts "Received new head at height: #{block_number}, block hash: #{block_hash}"
     else
-      client.chain_unsubscribeNewHead(subscription_id)
+      unsub_result = client.chain_unsubscribeNewHead(subscription_id)
+      puts "Unsubscribed from new heads: #{unsub_result}"
     end
   end
 

data/lib/client/ws_client.rb

@@ -6,6 +6,56 @@ require 'json'
 
 require_relative 'client_ext'
 
+module ScaleRb
+  class WsClient
+    def self.start(url)
+      Async do |task|
+        endpoint = Async::HTTP::Endpoint.parse(url, alpn_protocols: Async::HTTP::Protocol::HTTP11.names)
+        client = WsClient.new
+
+        task.async do
+          Async::WebSocket::Client.connect(endpoint) do |connection|
+            Async do
+              while request = client.next_request
+                ScaleRb.logger.debug "Sending request: #{request.to_json}"
+                connection.write(request.to_json)
+              end
+            end
+
+            # inside main task
+            while message = connection.read
+              data = JSON.parse(message)
+              ScaleRb.logger.debug "Received message: #{data}"
+
+              Async do
+                client.handle_response(data)
+              rescue => e
+                ScaleRb.logger.error "#{e.class}: #{e.message}"
+                ScaleRb.logger.error e.backtrace.join("\n")
+                task.stop
+              end
+            end
+          rescue => e
+            ScaleRb.logger.error "#{e.class}: #{e.message}"
+            ScaleRb.logger.error e.backtrace.join("\n")
+          ensure
+            task.stop
+          end
+        end
+
+        task.async do
+          client.supported_methods = client.rpc_methods()['methods']
+          yield client
+        rescue => e
+          ScaleRb.logger.error "#{e.class}: #{e.message}"
+          ScaleRb.logger.error e.backtrace.join("\n")
+          task.stop
+        end
+      end
+    end
+  end
+end
+
 module ScaleRb
   class WsClient
     include ClientExt
@@ -18,29 +68,35 @@ module ScaleRb
       @request_id = 1
     end
 
-    def request(method, params = [])
-      # don't check for rpc_methods, because there is no @supported_methods when initializing
+    def respond_to_missing?(method, *)
+      @supported_methods.include?(method.to_s)
+    end
+
+    def method_missing(method, *args)
+      method = method.to_s
+      ScaleRb.logger.debug "#{method}(#{args.join(', ')})"
+
+      # why not check 'rpc_methods', because there is no @supported_methods when initializing
       if method != 'rpc_methods' && !@supported_methods.include?(method)
         raise "Method `#{method}` is not supported. It should be in [#{@supported_methods.join(', ')}]."
       end
 
-      response_future = Async::Notification.new
-
-      @response_handler.register(@request_id, proc { |response|
-        # this is running in the main task
-        response_future.signal(response['result'])
-      })
-
-      request = JsonRpcRequest.new(@request_id, method, params)
-      @queue.enqueue(request)
-
-      @request_id += 1
+      if method.include?('unsubscribe')
+        unsubscribe(method, args[0])
+      elsif method.include?('subscribe')
+        raise "A subscribe method needs a block" unless block_given?
 
-      response_future.wait
+        subscribe(method, args) do |notification|
+          yield notification['params']['result']
+        end
+      else
+        request(method, args)
+      end
     end
 
     def subscribe(method, params = [], &block)
       return unless method.include?('subscribe')
+      return if method.include?('unsubscribe')
 
       subscription_id = request(method, params)
       @subscription_handler.subscribe(subscription_id, block)
@@ -48,9 +104,11 @@ module ScaleRb
     end
 
     def unsubscribe(method, subscription_id)
-      result = request(method, [subscription_id])
-      @subscription_handler.unsubscribe(subscription_id)
-      result
+      return unless method.include?('unsubscribe')
+
+      if @subscription_handler.unsubscribe(subscription_id)
+        request(method, [subscription_id])
+      end
     end
 
     def next_request
@@ -67,72 +125,22 @@ module ScaleRb
       end
     end
 
-    def respond_to_missing?(*_args)
-      true
-    end
-
-    def method_missing(method, *args)
-      ScaleRb.logger.debug "#{method}(#{args.join(', ')})"
+    private
 
-      method = method.to_s
-      if method.include?('unsubscribe')
-        unsubscribe(method, args[0])
-      elsif method.include?('subscribe')
-        raise "A subscribe method needs a block" unless block_given?
-
-        subscribe(method, args) do |notification|
-          yield notification['params']['result']
-        end
-      else
-        request(method, args)
-      end
-    end
-
-    def self.start(url)
-      Async do |task|
-        endpoint = Async::HTTP::Endpoint.parse(url, alpn_protocols: Async::HTTP::Protocol::HTTP11.names)
-        client = WsClient.new
+    def request(method, params = [])
+      response_future = Async::Notification.new
 
-        task.async do
-          Async::WebSocket::Client.connect(endpoint) do |connection|
-            Async do
-              while request = client.next_request
-                ScaleRb.logger.debug "Sending request: #{request.to_json}"
-                connection.write(request.to_json)
-              end
-            end
+      @response_handler.register(@request_id, proc { |response|
+        # this is running in the main task
+        response_future.signal(response['result'])
+      })
 
-            # inside main task
-            while message = connection.read
-              data = JSON.parse(message)
-              ScaleRb.logger.debug "Received message: #{data}"
+      request = JsonRpcRequest.new(@request_id, method, params)
+      @queue.enqueue(request)
 
-              # 可以简单的理解为，这里的handle_response就是通知wait中的request，可以继续了.
-              Async do
-                client.handle_response(data)
-              rescue => e
-                ScaleRb.logger.error "#{e.class}: #{e.message}"
-                ScaleRb.logger.error e.backtrace.join("\n")
-                task.stop
-              end
-            end
-          rescue => e
-            ScaleRb.logger.error "#{e.class}: #{e.message}"
-            ScaleRb.logger.error e.backtrace.join("\n")
-          ensure
-            task.stop
-          end
-        end
+      @request_id += 1
 
-        task.async do
-          client.supported_methods = client.request('rpc_methods')['methods']
-          yield client
-        rescue => e
-          ScaleRb.logger.error "#{e.class}: #{e.message}"
-          ScaleRb.logger.error e.backtrace.join("\n")
-          task.stop
-        end
-      end
+      response_future.wait
     end
   end
 
@@ -191,10 +199,20 @@ module ScaleRb
 
     def handle(notification)
       subscription_id = notification.dig('params', 'subscription')
-      if subscription_id && @subscriptions.key?(subscription_id)
+      return if subscription_id.nil?
+
+      if @subscriptions.key?(subscription_id)
         @subscriptions[subscription_id].call(notification)
       else
-        ScaleRb.logger.debug "Received a notification with unknown subscription id: #{notification}"
+        # the subscription_id may be not registered. 
+        # in client.subscribe function, 
+        #   ...
+        #   subscription_id = request(method, params)
+        #   @subscription_handler.subscribe(subscription_id, block)
+        #   ...
+        # the request(method, params) may be slow, so the subscription_id may be not registered when the first notification comes.
+        sleep 0.01
+        handle(notification)
       end
     end
   end

data/lib/scale_rb/version.rb

@@ -1,3 +1,3 @@
 module ScaleRb
-  VERSION = '0.3.0'
+  VERSION = '0.3.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scale_rb
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Aki Wu
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-07-14 00:00:00.000000000 Z
+date: 2024-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base58