scale_rb 0.2.2 → 0.3.0

data/lib/client/ws_client.rb

@@ -0,0 +1,202 @@
+require 'async'
+require 'async/websocket/client'
+require 'async/http/endpoint'
+require 'async/queue'
+require 'json'
+
+require_relative 'client_ext'
+
+module ScaleRb
+  class WsClient
+    include ClientExt
+    attr_accessor :supported_methods
+
+    def initialize
+      @queue = Async::Queue.new
+      @response_handler = ResponseHandler.new
+      @subscription_handler = SubscriptionHandler.new
+      @request_id = 1
+    end
+
+    def request(method, params = [])
+      # don't check for 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
+
+      response_future.wait
+    end
+
+    def subscribe(method, params = [], &block)
+      return unless method.include?('subscribe')
+
+      subscription_id = request(method, params)
+      @subscription_handler.subscribe(subscription_id, block)
+      subscription_id
+    end
+
+    def unsubscribe(method, subscription_id)
+      result = request(method, [subscription_id])
+      @subscription_handler.unsubscribe(subscription_id)
+      result
+    end
+
+    def next_request
+      @queue.dequeue
+    end
+
+    def handle_response(response)
+      if response.key?('id')
+        @response_handler.handle(response)
+      elsif response.key?('method')
+        @subscription_handler.handle(response)
+      else
+        puts "Received an unknown message: #{response}"
+      end
+    end
+
+    def respond_to_missing?(*_args)
+      true
+    end
+
+    def method_missing(method, *args)
+      ScaleRb.logger.debug "#{method}(#{args.join(', ')})"
+
+      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
+
+        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}"
+
+              # 可以简单的理解为，这里的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
+
+        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
+    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 = {}
+    end
+
+    # handler: a proc with response data as param
+    def register(id, handler)
+      @handlers[id] = handler
+    end
+
+    def handle(response)
+      id = response['id']
+      if @handlers.key?(id)
+        handler = @handlers[id]
+        handler.call(response)
+        @handlers.delete(id)
+      else
+        ScaleRb.logger.debug "Received a message with unknown id: #{response}"
+      end
+    end
+  end
+
+  class SubscriptionHandler
+    def initialize
+      @subscriptions = {}
+    end
+
+    def subscribe(subscription_id, handler)
+      @subscriptions[subscription_id] = handler
+    end
+
+    def unsubscribe(subscription_id)
+      @subscriptions.delete(subscription_id)
+    end
+
+    def handle(notification)
+      subscription_id = notification.dig('params', 'subscription')
+      if subscription_id && @subscriptions.key?(subscription_id)
+        @subscriptions[subscription_id].call(notification)
+      else
+        ScaleRb.logger.debug "Received a notification with unknown subscription id: #{notification}"
+      end
+    end
+  end
+
+end

data/lib/scale_rb/version.rb

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

data/lib/scale_rb.rb

@@ -20,15 +20,15 @@ require 'metadata/metadata'
 require 'hasher'
 require 'storage_helper'
 
-# client
-require 'client/http_client'
-require 'client/abstract_ws_client'
-
 # get registry from config
 require 'registry'
 
 require 'address'
 
+# clients
+require 'client/http_client'
+require 'client/ws_client'
+
 module ScaleRb
   class << self
     attr_accessor :logger

data/scale_rb.gemspec

@@ -6,11 +6,11 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Aki Wu']
   spec.email         = ['wuminzhe@gmail.com']
 
-  spec.summary       = 'New Ruby SCALE Codec Library'
-  spec.description   = 'Ruby implementation of the parity SCALE data format'
+  spec.summary       = 'A Ruby SCALE Codec Library, and, Substrate RPC Client'
+  spec.description   = 'This gem includes a ruby implementation of SCALE Codec, a general Substrate Http JSONRPC Client, and, a general Substrate Websocket JSON-RPC Client.'
   spec.homepage      = 'https://github.com/wuminzhe/scale_rb'
   spec.license       = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.6.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 3.1.1') # async gem's requirement
 
   spec.metadata['allowed_push_host'] = 'https://rubygems.org'
 
@@ -34,4 +34,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'base58'
   spec.add_dependency 'blake2b_rs', '~> 0.1.4'
   spec.add_dependency 'xxhash'
+  # for websocket client
+  spec.add_dependency 'async'
+  spec.add_dependency 'async-http', '~> 0.69.0'
+  spec.add_dependency 'async-websocket', '~> 0.26.2'
 end

data/tea.yaml

@@ -0,0 +1,6 @@
+# https://tea.xyz/what-is-this-file
+---
+version: 1.0.0
+codeOwners:
+  - '0x08D5966A5226C74f59407bC3aB3a63a68488Da1D'
+quorum: 1

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scale_rb
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Aki Wu
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-03-03 00:00:00.000000000 Z
+date: 2024-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base58
@@ -52,7 +52,50 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Ruby implementation of the parity SCALE data format
+- !ruby/object:Gem::Dependency
+  name: async
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: async-http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.69.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.69.0
+- !ruby/object:Gem::Dependency
+  name: async-websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.26.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.26.2
+description: This gem includes a ruby implementation of SCALE Codec, a general Substrate
+  Http JSONRPC Client, and, a general Substrate Websocket JSON-RPC Client.
 email:
 - wuminzhe@gmail.com
 executables:
@@ -72,13 +115,17 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- examples/http_client_1.rb
+- examples/http_client_2.rb
+- examples/ws_client_1.rb
+- examples/ws_client_2.rb
+- examples/ws_client_3.rb
+- examples/ws_client_4.rb
 - exe/metadata
 - lib/address.rb
-- lib/client/abstract_ws_client.rb
+- lib/client/client_ext.rb
 - lib/client/http_client.rb
-- lib/client/http_client_metadata.rb
-- lib/client/http_client_storage.rb
-- lib/client/rpc_request_builder.rb
+- lib/client/ws_client.rb
 - lib/codec.rb
 - lib/hasher.rb
 - lib/metadata/metadata.rb
@@ -95,13 +142,14 @@ files:
 - lib/scale_rb/version.rb
 - lib/storage_helper.rb
 - scale_rb.gemspec
+- tea.yaml
 homepage: https://github.com/wuminzhe/scale_rb
 licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/wuminzhe/scale_rb/issues/
   source_code_uri: https://github.com/wuminzhe/scale_rb.git
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -109,15 +157,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.1.1
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.4.19
+signing_key: 
 specification_version: 4
-summary: New Ruby SCALE Codec Library
+summary: A Ruby SCALE Codec Library, and, Substrate RPC Client
 test_files: []

data/lib/client/abstract_ws_client.rb

@@ -1,104 +0,0 @@
-# frozen_string_literal: true
-
-require_relative './rpc_request_builder'
-
-module ScaleRb
-  class AbstractWsClient
-    extend RpcRequestBuilder
-    attr_accessor :metadata, :registry
-
-    def initialize
-      @id = 0
-      @metadata = nil
-      @registry = nil
-      @callbacks = {}
-      @subscription_callbacks = {}
-    end
-
-    def send_json_rpc(_body)
-      raise 'WsClient is a abstract base class for websocket client, please use its sub-class'
-    end
-
-    # changes: [
-    #   [
-    #     "0x26aa394eea5630e07c48ae0c9558cef780d41e5e16056765bc8461851072c9d7", # storage key
-    #     "0x0400000000000000d887690900000000020000" # change
-    #   ]
-    # ]
-    def process(resp)
-      # handle id
-      @callbacks[resp['id']]&.call(resp['id'], resp) if resp['id']
-
-      # handle storage subscription
-      return unless resp['params'] && resp['params']['subscription']
-      return unless @metadata && @registry
-
-      subscription = resp['params']['subscription']
-      changes = resp['params']['result']['changes']
-      block = resp['params']['result']['block']
-      p "block: #{block}"
-
-      return unless @subscription_callbacks[subscription]
-
-      pallet_name, item_name, subscription_callback = @subscription_callbacks[subscription]
-      storage_item = Metadata.get_storage_item(pallet_name, item_name, @metadata)
-      storages = decode_storages(changes.map(&:last), storage_item, registry)
-      subscription_callback.call(storages)
-    end
-
-    def get_metadata(callback = nil)
-      if callback.nil?
-        callback = lambda do |id, resp|
-          return unless resp['id'] && resp['result']
-          return if resp['id'] != id
-
-          metadata_hex = resp['result']
-          metadata = Metadata.decode_metadata(metadata_hex.strip._to_bytes)
-          return unless metadata
-
-          @metadata = metadata
-          @registry = Metadata.build_registry(@metadata)
-        end
-      end
-
-      id = bind_id_to(callback)
-      body = state_getMetadata(id)
-      send_json_rpc(body)
-    end
-
-    def subscribe_storage(pallet_name, item_name, subscription_callback, key = nil, registry = nil)
-      callback = create_callback_for_subscribe_storage(pallet_name, item_name, subscription_callback)
-      id = bind_id_to(callback)
-      body = derived_state_subscribe_storage(id, pallet_name, item_name, key, registry)
-      send_json_rpc(body)
-    end
-
-    private
-
-    def bind_id_to(callback)
-      @callbacks[@id] = callback
-      old = @id
-      @id += 1
-      old
-    end
-
-    def decode_storages(datas, storage_item, registry)
-      datas.map do |data|
-        StorageHelper.decode_storage2(data, storage_item, registry)
-      end
-    end
-
-    def create_callback_for_subscribe_storage(pallet_name, item_name, subscription_callback)
-      lambda do |id, resp|
-        return unless resp['id'] && resp['result']
-        return if resp['id'] != id
-
-        @subscription_callbacks[resp['result']] = [
-          pallet_name,
-          item_name,
-          subscription_callback
-        ]
-      end
-    end
-  end
-end

data/lib/client/http_client_metadata.rb

@@ -1,78 +0,0 @@
-require 'json'
-require 'fileutils'
-
-module ScaleRb
-  module HttpClient
-    class << self
-      def get_metadata(url, at = nil)
-        hex = state_getMetadata(url, at)
-        Metadata.decode_metadata(hex.strip._to_bytes)
-      end
-
-      # cached version of get_metadata
-      # get metadata from cache first
-      def get_metadata_cached(url, at: nil, dir: nil)
-        dir = ENV['SCALE_RB_METADATA_DIR'] || File.join(Dir.pwd, 'metadata') if dir.nil?
-
-        at = ScaleRb::HttpClient.chain_getFinalizedHead(url) if at.nil?
-        spec_name, spec_version = get_spec(url, at)
-
-        # get metadata from cache first
-        metadata = metadata_cached(
-          spec_name: spec_name,
-          spec_version: spec_version,
-          dir: dir
-        )
-        return metadata if metadata
-
-        # get metadata from rpc
-        metadata = ScaleRb::HttpClient.get_metadata(url, at)
-
-        # cache it
-        ScaleRb.logger.debug "caching metadata `#{spec_name}_#{spec_version}.json`"
-        save_metadata_to_file(
-          spec_name: spec_name,
-          spec_version: spec_version,
-          metadata: metadata,
-          dir: dir
-        )
-
-        metadata
-      end
-
-      private
-
-      def get_spec(url, at)
-        runtime_version = ScaleRb::HttpClient.state_getRuntimeVersion(url, at)
-        spec_name = runtime_version['specName']
-        spec_version = runtime_version['specVersion']
-        [spec_name, spec_version]
-      end
-
-      def metadata_cached(spec_name:, spec_version:, dir:)
-        raise 'spec_version is required' unless spec_version
-        raise 'spec_name is required' unless spec_name
-
-        file_path = File.join(dir, "#{spec_name}_#{spec_version}.json")
-        return unless File.exist?(file_path)
-
-        ScaleRb.logger.debug "found metadata `#{spec_name}_#{spec_version}.json` in cache"
-        JSON.parse(File.read(file_path))
-      end
-
-      def save_metadata_to_file(spec_name:, spec_version:, metadata:, dir:)
-        FileUtils.mkdir_p(dir)
-
-        File.open(File.join(dir, "#{spec_name}_#{spec_version}.json"), 'w') do |f|
-          f.write(JSON.pretty_generate(metadata))
-        end
-      end
-
-      def require_block_hash_correct(url, block_hash)
-        return unless ScaleRb::HttpClient.chain_getHeader(url, block_hash).nil?
-
-        raise 'Unable to retrieve header and parent from supplied hash'
-      end
-    end
-  end
-end