scale_rb 0.3.2 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b1c3f0276dedfa00a80fed47d5647ced3d6128667e0b6e3ac38733351cb3dac
-  data.tar.gz: 5e137b28a94a898949937e3d10d043b80627f46232a9f5d49ba27766fbac6659
+  metadata.gz: 946dbb730e56172125e2524d66c41650fb08a3b799576000b5254467080ec771
+  data.tar.gz: cae0b7ce708380ceeefa2bdd412abc30adbc5de5153b68bec12625497cf89e03
 SHA512:
-  metadata.gz: 0416b944d3a0ccb254390e47c019c5692d04dc3f1c86f6033e6ceaac8e5e8a18c530e20a224ff19975b5acf8413f9e12da16cc6a24253a6f08d09972f981bdea
-  data.tar.gz: 74e2acc6ee10c7928c7528fa42cdf1dc8c9a778f56c77136a5d9305619b0eb386d752ce3a9902589bed61ffe9eaf74a14446b7579c622fea73d34b960693287e
+  metadata.gz: 3d9b11df5acc3538b9fd7af4aabd1db74f9fb0f08ab7bc2620299d2145beee2805eeee12b1948e33a9198b0141b4b6c57187bb99f984743dbfb1c7e62e9b0ca7
+  data.tar.gz: df6d923402362b259384fe585a83ee490dc3e5bc5154d41b886a74ee1ab19d3e1fa0e92c0a3f8c2b5ffb976f12138418728b0c046ac23470bb1954b12a65a048

data/.gitignore

@@ -11,3 +11,4 @@
 # rspec failure tracking
 .rspec_status
 /metadata
+Gemfile.lock

data/Gemfile

@@ -5,3 +5,4 @@ gemspec
 
 gem "rake", "~> 12.0"
 gem "rspec", "~> 3.0"
+gem 'rubocop', group: 'development', require: false

data/README.md

@@ -1,11 +1,13 @@
 # ScaleRb
 
+It is still under heavy development. Use the latest version.
+
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'scale_rb'
+gem 'scale_rb', '~> 0.3.5'
 ```
 
 And then execute:

data/examples/http_client_2.rb

@@ -3,7 +3,13 @@ require 'scale_rb'
 ScaleRb.logger.level = Logger::DEBUG
 
 client = ScaleRb::HttpClient.new('https://polkadot-rpc.dwellir.com')
-block_number = 21585684
+block_number = 21711742
 block_hash = client.chain_getBlockHash(block_number)
-storage = client.get_storage(block_hash, 'System', 'Events')
+metadata = client.get_metadata(block_hash)
+
+storage_query = ScaleRb::WsClient::StorageQuery.new(
+  pallet_name: 'System',
+  storage_name: 'Events',
+)
+storage = client.get_storage(block_hash, storage_query, metadata)
 puts "block #{block_number}(#{block_hash}) has #{storage.length} events"

data/examples/ws_client_1.rb

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

data/examples/ws_client_2.rb

@@ -1,9 +1,14 @@
 require 'scale_rb'
 
-ScaleRb.logger.level = Logger::DEBUG
-
+# You can have multiple subscriptions at the same time
 ScaleRb::WsClient.start('wss://polkadot-rpc.dwellir.com') do |client|
   client.chain_subscribeNewHead do |head|
-    puts "Received new head at height: #{head['number'].to_i(16)}"
+    puts "Received new head at height: #{head[:number].to_i(16)}"
+  end
+
+  client.state_subscribeStorage do |storage|
+    block_hash = storage[:block]
+    changes = storage[:changes]
+    puts "Received #{changes.size} storage changes at block: #{block_hash}"
   end
 end

data/examples/ws_client_3.rb

@@ -2,19 +2,20 @@ require 'scale_rb'
 
 # ScaleRb.logger.level = Logger::DEBUG
 
+# Unsubscribe after receiving 4 new heads
 ScaleRb::WsClient.start('wss://polkadot-rpc.dwellir.com') do |client|
   count = 0
 
   subscription_id = client.chain_subscribeNewHead do |head|
-    count = count + 1
+    count += 1
 
     if count < 5
-      block_number = head['number'].to_i(16)
+      block_number = head[:number].to_i(16)
       block_hash = client.chain_getBlockHash(block_number)
       puts "Received new head at height: #{block_number}, block hash: #{block_hash}"
     else
       unsub_result = client.chain_unsubscribeNewHead(subscription_id)
-      puts "Unsubscribed from new heads: #{unsub_result}"
+      puts "Unsubscribe result: #{unsub_result}"
     end
   end
 

data/examples/ws_client_error_handling.rb

@@ -0,0 +1,9 @@
+require 'scale_rb'
+
+begin
+  ScaleRb::WsClient.start('wss://polkadot-rpc.dwellir.com') do |_client|
+    raise 'MyError'
+  end
+rescue StandardError => e
+  p e.message # "MyError"
+end

data/lib/client/client_ext.rb

@@ -42,7 +42,7 @@ module ScaleRb
     def query_storage_at(block_hash, storage_keys, type_id, default, registry)
       result = state_queryStorageAt(storage_keys, block_hash)
       result.map do |item|
-        item['changes'].map do |change|
+        item[:changes].map do |change|
           storage_key = change[0]
           data = change[1] || default
           storage = data.nil? ? nil : PortableCodec.decode(type_id, data._to_bytes, registry)[0]

data/lib/client/http_client.rb

@@ -17,7 +17,7 @@ module ScaleRb
       raise 'url format is not correct' unless url.match?(url_regex)
 
       @uri = URI.parse(url)
-      @supported_methods = request('rpc_methods', [])['methods']
+      @supported_methods = request('rpc_methods', [])[:methods]
     end
 
     def request(method, params = [])
@@ -37,11 +37,12 @@ module ScaleRb
       response = http.request(request)
       raise response unless response.is_a?(Net::HTTPOK)
 
-      body = JSON.parse(response.body)
+      # parse response, make key symbol
+      body = JSON.parse(response.body, symbolize_names: true)
       ScaleRb.logger.debug "Response: #{body}"
-      raise body['error'] if body['error']
+      raise body[:error] if body[:error]
 
-      body['result']
+      body[:result]
     end
 
     def respond_to_missing?(*_args)
@@ -54,4 +55,4 @@ module ScaleRb
       request(method.to_s, args)
     end
   end
-end
+end

data/lib/client/ws_client.rb

@@ -1,58 +1,55 @@
 require 'async'
 require 'async/websocket/client'
 require 'async/http/endpoint'
-require 'async/queue'
-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
+    class << self
+      # @param [string] url
+      def start(url)
+        Sync do
+          endpoint = Async::HTTP::Endpoint.parse(url, alpn_protocols: Async::HTTP::Protocol::HTTP11.names)
+
           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)
+            client = WsClient.new(connection)
+
+            # `recv_task` does not raise errors (subclass of StandardError), so it will not be stopped by any errors.
+            recv_task = Async do
+              while (message = client.read_message)
+                data = parse_message(message)
+                next if data.nil?
+
+                ScaleRb.logger.debug "Received response: #{data}"
+                Async do
+                  client.handle_response(data)
+                end
               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")
+            client.supported_methods = client.rpc_methods()[:methods]
+            yield client
+
+            recv_task.wait
           ensure
-            task.stop
+            recv_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
+
+      private
+
+      def parse_message(message)
+        message.parse
+      rescue StandardError => e
+        ScaleRb.logger.error "Error while parsing message: #{e.inspect}, message: #{message}"
+        nil
       end
     end
+
   end
 end
 
@@ -61,8 +58,8 @@ module ScaleRb
     include ClientExt
     attr_accessor :supported_methods
 
-    def initialize
-      @queue = Async::Queue.new
+    def initialize(connection)
+      @connection = connection
       @response_handler = ResponseHandler.new
       @subscription_handler = SubscriptionHandler.new
       @request_id = 1
@@ -84,10 +81,10 @@ module ScaleRb
       if method.include?('unsubscribe')
         unsubscribe(method, args[0])
       elsif method.include?('subscribe')
-        raise "A subscribe method needs a block" unless block_given?
+        raise 'A subscribe method needs a block' unless block_given?
 
         subscribe(method, args) do |notification|
-          yield notification['params']['result']
+          yield notification[:params][:result]
         end
       else
         request(method, args)
@@ -111,17 +108,27 @@ module ScaleRb
       end
     end
 
-    def next_request
-      @queue.dequeue
-    end
-
     def handle_response(response)
-      if response.key?('id')
+      if response.key?(:id)
         @response_handler.handle(response)
-      elsif response.key?('method')
+      elsif response.key?(:method)
         @subscription_handler.handle(response)
       else
-        puts "Received an unknown message: #{response}"
+        ScaleRb.logger.info "Received an unknown response: #{response}"
+      end
+    rescue StandardError => e
+      ScaleRb.logger.error "Error while handling response: #{e.inspect}"
+      ScaleRb.logger.debug e.backtrace.join("\n")
+    end
+
+    def read_message
+      loop do
+        return @connection.read
+      rescue StandardError => e
+        ScaleRb.logger.error "Error while read message from connection: #{e.inspect}"
+        ScaleRb.logger.debug e.backtrace.join("\n")
+        sleep 1
+        retry
       end
     end
 
@@ -131,88 +138,59 @@ module ScaleRb
       response_future = Async::Notification.new
 
       @response_handler.register(@request_id, proc { |response|
-        # this is running in the main task
-        response_future.signal(response['result'])
+        response_future.signal(response[:result])
       })
 
-      request = JsonRpcRequest.new(@request_id, method, params)
-      @queue.enqueue(request)
+      request = { jsonrpc: '2.0', id: @request_id, method: method, params: params }
+      ScaleRb.logger.debug "Sending request: #{request}"
+      @connection.write(request.to_json)
 
       @request_id += 1
-
       response_future.wait
     end
   end
 
-  class JsonRpcRequest
-    attr_reader :id, :method, :params
-
-    def initialize(id, method, params = {})
-      @id = id
-      @method = method
-      @params = params
-    end
-
-    def to_json(*_args)
-      { jsonrpc: '2.0', id: @id, method: @method, params: @params }.to_json
-    end
-
-    # def to_s
-    #   to_json
-    # end
-  end
-
   class ResponseHandler
     def initialize
-      @handlers = {}
+      @callbacks = {}
     end
 
-    # handler: a proc with response data as param
-    def register(id, handler)
-      @handlers[id] = handler
+    # callback: a proc with response data as param
+    def register(id, callback)
+      @callbacks[id] = callback
     end
 
     def handle(response)
-      id = response['id']
-      if @handlers.key?(id)
-        handler = @handlers[id]
-        handler.call(response)
-        @handlers.delete(id)
+      id = response[:id]
+      if @callbacks.key?(id)
+        callback = @callbacks[id]
+        callback.call(response)
+        @callbacks.delete(id)
       else
-        ScaleRb.logger.debug "Received a message with unknown id: #{response}"
+        ScaleRb.logger.info "Received a message with unknown id: #{response}"
       end
     end
   end
 
   class SubscriptionHandler
     def initialize
-      @subscriptions = {}
+      @callbacks = {}
     end
 
-    def subscribe(subscription_id, handler)
-      @subscriptions[subscription_id] = handler
+    def subscribe(subscription_id, callback)
+      @callbacks[subscription_id] = callback
     end
 
     def unsubscribe(subscription_id)
-      @subscriptions.delete(subscription_id)
+      @callbacks.delete(subscription_id)
     end
 
     def handle(notification)
-      subscription_id = notification.dig('params', 'subscription')
+      subscription_id = notification.dig(:params, :subscription)
       return if subscription_id.nil?
 
-      if @subscriptions.key?(subscription_id)
-        @subscriptions[subscription_id].call(notification)
-      else
-        # 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)
+      if @callbacks.key?(subscription_id)
+        @callbacks[subscription_id].call(notification)
       end
     end
   end

data/lib/scale_rb/version.rb

@@ -1,3 +1,3 @@
 module ScaleRb
-  VERSION = '0.3.2'
+  VERSION = '0.3.5'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scale_rb
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.5
 platform: ruby
 authors:
 - Aki Wu
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-19 00:00:00.000000000 Z
+date: 2024-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base58
@@ -109,7 +109,6 @@ files:
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -121,6 +120,7 @@ files:
 - examples/ws_client_2.rb
 - examples/ws_client_3.rb
 - examples/ws_client_4.rb
+- examples/ws_client_error_handling.rb
 - exe/metadata
 - lib/address.rb
 - lib/client/client_ext.rb

data/Gemfile.lock

@@ -1,97 +0,0 @@
-PATH
-  remote: .
-  specs:
-    scale_rb (0.3.2)
-      async
-      async-http (~> 0.69.0)
-      async-websocket (~> 0.26.2)
-      base58
-      blake2b_rs (~> 0.1.4)
-      xxhash
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    async (2.14.2)
-      console (~> 1.25, >= 1.25.2)
-      fiber-annotation
-      io-event (~> 1.6, >= 1.6.5)
-    async-http (0.69.0)
-      async (>= 2.10.2)
-      async-pool (~> 0.7)
-      io-endpoint (~> 0.11)
-      io-stream (~> 0.4)
-      protocol-http (~> 0.26)
-      protocol-http1 (~> 0.19)
-      protocol-http2 (~> 0.18)
-      traces (>= 0.10)
-    async-pool (0.7.0)
-      async (>= 1.25)
-    async-websocket (0.26.2)
-      async-http (~> 0.54)
-      protocol-rack (~> 0.5)
-      protocol-websocket (~> 0.14)
-    base58 (0.2.3)
-    blake2b_rs (0.1.4)
-      ffi (~> 1.0)
-      thermite (~> 0)
-    console (1.27.0)
-      fiber-annotation
-      fiber-local (~> 1.1)
-      json
-    diff-lcs (1.5.0)
-    ffi (1.17.0)
-    fiber-annotation (0.2.0)
-    fiber-local (1.1.0)
-      fiber-storage
-    fiber-storage (0.1.2)
-    io-endpoint (0.13.0)
-    io-event (1.6.5)
-    io-stream (0.4.0)
-    json (2.7.2)
-    minitar (0.9)
-    protocol-hpack (1.4.3)
-    protocol-http (0.28.1)
-    protocol-http1 (0.19.1)
-      protocol-http (~> 0.22)
-    protocol-http2 (0.18.0)
-      protocol-hpack (~> 1.4)
-      protocol-http (~> 0.18)
-    protocol-rack (0.6.0)
-      protocol-http (~> 0.23)
-      rack (>= 1.0)
-    protocol-websocket (0.15.0)
-      protocol-http (~> 0.2)
-    rack (3.1.7)
-    rake (12.3.3)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.0)
-    thermite (0.13.0)
-      minitar (~> 0.5)
-      rake (>= 10)
-      tomlrb (~> 1.2)
-    tomlrb (1.3.0)
-    traces (0.11.1)
-    xxhash (0.5.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  rake (~> 12.0)
-  rspec (~> 3.0)
-  scale_rb!
-
-BUNDLED WITH
-   2.1.4