scale_rb 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6df0775bbed0fb5886ee7aba23efa8660dfde37a1f437d1d83958a6cc3f82c1f
-  data.tar.gz: a6ad3ab392fdaa8b9a3f431f98a6d1e7b099b5ce43cb966e5055267d5515322d
+  metadata.gz: 51cde569bc10814d0163c4b972c1d926a5ef69a044d02e88085db5bfdd9119a0
+  data.tar.gz: 694a2356b2626d1491c2dbb5cca8207179e614a88579c99bbd43a312c2435f9d
 SHA512:
-  metadata.gz: fd7a0fbc2f605c3fef4a0b88e7c8475db9ac7e63223130536fddb786040fc4af79e9306f101697e2ae990f04d913755086df2965e8b922638c7c8498455c0fc8
-  data.tar.gz: 378a219709b0cce2ea277b3e717bd2b0653984519c7593e5525a841155a47b1478c6a10cebf29480cc862cac78b33287e34c1a9a7f433679a8d9e66cfe0ce356
+  metadata.gz: cbe20c371a268df323e64fcd9b142a8d04b87dc00e7079e1fd5e0979cbd4311de10b20687928200c427c407d839ce6ba0c804d5e08c72001a05d16b25b6faee8
+  data.tar.gz: 7e36ec4ef1d6e0b5584464498836fa5f19f4f7d194856c15bd25165bc6dd7f9f01e97cf0c736bc734806be83a26cc70b1fcb3b5986f95ba8fde0361dc76227b5

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

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

data/examples/http_client_2.rb

@@ -1,15 +1,20 @@
 require 'scale_rb'
 
+def fetch_some_storages(client, block_number)
+  start_time = Time.now
+
+  block_hash = client.chain_getBlockHash(block_number)
+  metadata = client.get_metadata(block_hash)
+  puts "event count: #{client.get_storage('System', 'EventCount', block_hash:, metadata:)}"
+  puts "treasury proposal #854: #{client.get_storage('Treasury', 'Proposals', [854], block_hash:, metadata:)}"
+  puts "all treasury proposals: #{client.get_storage('Treasury', 'Proposals', block_hash:, metadata:)}"
+  puts "child bounties: #{client.get_storage('ChildBounties', 'ChildBounties', [11, 1646], block_hash:, metadata:)}"
+
+  end_time = Time.now
+  puts "Time taken: #{end_time - start_time} seconds"
+end
+
 ScaleRb.logger.level = Logger::DEBUG
 
 client = ScaleRb::HttpClient.new('https://polkadot-rpc.dwellir.com')
-block_number = 21711742
-block_hash = client.chain_getBlockHash(block_number)
-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"
+fetch_some_storages(client, 21711742)

data/examples/ws_client_3.rb

@@ -2,12 +2,12 @@ require 'scale_rb'
 
 # ScaleRb.logger.level = Logger::DEBUG
 
-# Unsubscribe after receiving 5 new heads
+# 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)

data/examples/ws_client_4.rb

@@ -1,43 +1,21 @@
 require 'scale_rb'
 
-# ScaleRb.logger.level = Logger::DEBUG
+def fetch_some_storages(client, block_number)
+  start_time = Time.now
 
-ScaleRb::WsClient.start('wss://polkadot-rpc.dwellir.com') do |client|
-  block_number = 21711742
   block_hash = client.chain_getBlockHash(block_number)
   metadata = client.get_metadata(block_hash)
+  puts "event count: #{client.get_storage('System', 'EventCount', block_hash:, metadata:)}"
+  puts "treasury proposal #854: #{client.get_storage('Treasury', 'Proposals', [854], block_hash:, metadata:)}"
+  puts "all treasury proposals: #{client.get_storage('Treasury', 'Proposals', block_hash:, metadata:)}"
+  puts "child bounties: #{client.get_storage('ChildBounties', 'ChildBounties', [11, 1646], block_hash:, metadata:)}"
 
-  storage_query = ScaleRb::WsClient::StorageQuery.new(
-    pallet_name: 'System',
-    storage_name: 'EventCount',
-  )
-  puts "event count: #{client.get_storage(block_hash, storage_query, metadata)}"
-  # event count: 48
-
-
-  storage_query = ScaleRb::WsClient::StorageQuery.new(
-    pallet_name: 'Treasury',
-    storage_name: 'Proposals',
-    key_part1: 854,
-  )
-  puts "treasury proposal #854: #{client.get_storage(block_hash, storage_query, metadata)}"
-  # treasury proposal #854: {:proposer=>"0xb6f0f10eec993f3e6806eb6cc4d2f13d5f5a90a17b855a7bf9847a87e07ee322", :value=>82650000000000, :beneficiary=>"0xb6f0f10eec993f3e6806eb6cc4d2f13d5f5a90a17b855a7bf9847a87e07ee322", :bond=>0}
-
-
-  storage_query = ScaleRb::WsClient::StorageQuery.new(
-    pallet_name: 'Treasury',
-    storage_name: 'Proposals',
-  )
-  puts "all treasury proposals: #{client.get_storage(block_hash, storage_query, metadata)}"
-  # all treasury proposals: [{:storage_key=>"0x89d139e01a5eb2256f222e5fc5dbe6b388c2f7188c6fdd1dffae2fa0d171f4400c1910093df9204856030000", :storage=>{:proposer=>"0xb6f0f10eec993f3e6806eb6cc4d2f13d5f5a90a17b855a7bf9847a87e07ee322", :value=>82650000000000, :beneficiary=>"0xb6f0f10eec993f3e6806eb6cc4d2f13d5f5a90a17b855a7bf9847a87e07ee322", :bond=>0}}, ...]
+  end_time = Time.now
+  puts "Time taken: #{end_time - start_time} seconds"
+end
 
+ScaleRb.logger.level = Logger::DEBUG
 
-  storage_query = ScaleRb::WsClient::StorageQuery.new(
-    pallet_name: 'ChildBounties',
-    storage_name: 'ChildBounties',
-    key_part1: 11,
-    key_part2: 1646
-  )
-  puts "child bounties: #{client.get_storage(block_hash, storage_query, metadata)}"
-  # child bounties: {:parent_bounty=>11, :value=>3791150000000, :fee=>0, :curator_deposit=>0, :status=>{:PendingPayout=>{:curator=>"0xb1725c0de514e0df808b19dbfca26672019ea5f9e2eb69c0055c7f1d01b4f18a", :beneficiary=>"0xb089dedc24a15308874dc862b035d74f2f7b45cad475d6121a2d944921bbe237", :unlock_at=>21703671}}}
+ScaleRb::WsClient.start('wss://polkadot-rpc.dwellir.com') do |client|
+  fetch_some_storages(client, 21711742)
 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

@@ -2,37 +2,31 @@ module ScaleRb
 
   # This module is used to add extra methods to both the ScaleRb::WsClient ScaleRb::HttpClient
   module ClientExt
-    StorageQuery = Struct.new(:pallet_name, :storage_name, :key_part1, :key_part2, keyword_init: true) do
-      def initialize(pallet_name:, storage_name:, key_part1: nil, key_part2: nil)
-        super
-      end
-    end
-
     # get decoded metadata at block_hash
-    def get_metadata(block_hash)
+    def get_metadata(block_hash = nil)
+      block_hash ||= chain_getHead
       metadata_hex = state_getMetadata(block_hash)
       ScaleRb::Metadata.decode_metadata(metadata_hex.strip._to_bytes)
     end
 
     # Get decoded storage at block_hash
-    def get_storage(block_hash, storage_query, metadata = nil)
+    def get_storage(pallet_name, storage_name, params = [], block_hash: nil, metadata: nil)
+      block_hash ||= chain_getHead
       metadata ||= get_metadata(block_hash)
 
       # storeage item
-      pallet_name = convert_to_camel_case storage_query.pallet_name
-      storage_name = convert_to_camel_case storage_query.storage_name
+      pallet_name = convert_to_camel_case pallet_name
+      storage_name = convert_to_camel_case storage_name
 
       # storage param
-      key = [storage_query.key_part1, storage_query.key_part2].compact
-      ScaleRb.logger.debug "#{pallet_name}.#{storage_name}(#{key.join(', ')})"
-      key = key.map { |part_of_key| c(part_of_key) }
-      ScaleRb.logger.debug "converted key: #{key}"
+      ScaleRb.logger.debug "#{pallet_name}.#{storage_name}(#{params.inspect})"
+      params = params.map { |param| c(param) }
 
       get_storage2(
         block_hash, # at
         pallet_name,
         storage_name,
-        key,
+        params,
         metadata
       )
     end
@@ -102,7 +96,7 @@ module ScaleRb
     #
     # key is for the param, value is for the return
     def get_storage1(block_hash, pallet_name, item_name, key, value, registry)
-      ScaleRb::logger.debug "get_storage1: #{pallet_name}.#{item_name} key: #{key} value: #{value}"
+      ScaleRb.logger.debug "#{pallet_name}.#{item_name}, key: #{key.inspect}, value: #{value}"
 
       if key
         if key[:value].nil? || key[:value].empty?
@@ -138,7 +132,6 @@ module ScaleRb
     end
 
     def get_storage2(block_hash, pallet_name, item_name, params, metadata)
-      ScaleRb.logger.debug "get_storage2: #{pallet_name}.#{item_name} params: #{params}"
       raise 'Metadata should not be nil' if metadata.nil?
 
       registry = Metadata.build_registry(metadata)

data/lib/client/http_client.rb

@@ -50,7 +50,7 @@ module ScaleRb
     end
 
     def method_missing(method, *args)
-      ScaleRb.logger.debug "#{method}(#{args.join(', ')})"
+      # ScaleRb.logger.debug "#{method}(#{args.join(', ')})"
 
       request(method.to_s, args)
     end

data/lib/client/ws_client.rb

@@ -1,42 +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)
 
-      Sync do |task|
-        endpoint = Async::HTTP::Endpoint.parse(url, alpn_protocols: Async::HTTP::Protocol::HTTP11.names)
-
-        Async::WebSocket::Client.connect(endpoint) do |connection|
-          client = WsClient.new(connection)
-
-          recv_task = task.async do
-            while message = connection.read
-              data = message.parse
-              ScaleRb.logger.debug "Received message: #{data}"
-
-              task.async do
-                client.handle_response(data)
+    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|
+            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 "Response: #{data}"
+                Async do
+                  client.handle_response(data)
+                end
               end
             end
-          end
 
-          client.supported_methods = client.rpc_methods()[:methods]
-          yield client
+            client.supported_methods = client.rpc_methods()[:methods]
+            yield client
 
-          recv_task.wait
-        ensure
-          recv_task&.stop
+            recv_task.wait
+          ensure
+            recv_task&.stop
+          end
         end
-      end # Sync
 
-    end # start
+      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
 
@@ -58,7 +71,7 @@ module ScaleRb
 
     def method_missing(method, *args)
       method = method.to_s
-      ScaleRb.logger.debug "#{method}(#{args.join(', ')})"
+      # 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)
@@ -68,7 +81,7 @@ 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]
@@ -101,7 +114,21 @@ module ScaleRb
       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
 
@@ -115,7 +142,7 @@ module ScaleRb
       })
 
       request = { jsonrpc: '2.0', id: @request_id, method: method, params: params }
-      ScaleRb.logger.debug "Sending request: #{request}"
+      ScaleRb.logger.debug "Request: #{request}"
       @connection.write(request.to_json)
 
       @request_id += 1
@@ -140,7 +167,7 @@ module ScaleRb
         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

data/lib/codec.rb

@@ -404,6 +404,8 @@ module ScaleRb
     end
 
     def encode_uint(type, value)
+      raise InvalidValueError, "type: #{type}, value: #{value.inspect}" unless value.instance_of?(Integer)
+
       bit_length = type[1..].to_i
       value._to_bytes(bit_length)._flip
     end

data/lib/scale_rb/version.rb

@@ -1,3 +1,3 @@
 module ScaleRb
-  VERSION = '0.3.3'
+  VERSION = '0.4.0'
 end

data/lib/storage_helper.rb

@@ -20,12 +20,14 @@ module ScaleRb
               ]
             else
               [
-                registry[key[:type]]._get(:def)._get(:tuple),
+                registry[key[:type]]._get(:def)._get(:tuple).first(key[:value].length),
                 key[:value],
-                key[:hashers]
+                key[:hashers].first(key[:value].length)
               ]
             end
 
+          ScaleRb.logger.debug "encode_storage_key: key_values: #{key_values.inspect}, key_types: #{key_types.inspect}, key_hashers: #{key_hashers.inspect}"
+
           if key_types.class != key_values.class || key_types.length != key_values.length
             raise "Key's value doesn't match key's type, key's value: #{key_values.inspect}, but key's type: #{key_types.inspect}. Please check your key's value."
           end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scale_rb
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Aki Wu
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-30 00:00:00.000000000 Z
+date: 2024-08-04 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
@@ -149,7 +149,7 @@ licenses:
 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
@@ -164,8 +164,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: A Ruby SCALE Codec Library, and, Substrate RPC Client
 test_files: []

data/Gemfile.lock

@@ -1,97 +0,0 @@
-PATH
-  remote: .
-  specs:
-    scale_rb (0.3.3)
-      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.5.0)
-    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