scale_rb 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5b8734ff8c6eda16208a8bb532ee411e15eaf04bf53f5f0f4d8465724b5f89e
-  data.tar.gz: 4aabf928980af1c7d2c6db2857c832743a9288f4e5b7cd17007ce6c25d7def1f
+  metadata.gz: 6b1c3f0276dedfa00a80fed47d5647ced3d6128667e0b6e3ac38733351cb3dac
+  data.tar.gz: 5e137b28a94a898949937e3d10d043b80627f46232a9f5d49ba27766fbac6659
 SHA512:
-  metadata.gz: 2645dc18deb5d1d95bb28a4ad89512d2a05e9651f19eb48c3090895ab8fa16795204d09dbef9214168ba03126f0f2e6251e654b1bfb9766f12a3d85fc8801af1
-  data.tar.gz: 0ffb2cf53f4e46014f624f5e7d6d60cb8f92a9dabc74c97b90bf26725c3a6a80ffae96408df6aa0d4295d8ecef80b0f5520c74acb3f63a14d218084d48dd1abb
+  metadata.gz: 0416b944d3a0ccb254390e47c019c5692d04dc3f1c86f6033e6ceaac8e5e8a18c530e20a224ff19975b5acf8413f9e12da16cc6a24253a6f08d09972f981bdea
+  data.tar.gz: 74e2acc6ee10c7928c7528fa42cdf1dc8c9a778f56c77136a5d9305619b0eb386d752ce3a9902589bed61ffe9eaf74a14446b7579c622fea73d34b960693287e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    scale_rb (0.3.1)
+    scale_rb (0.3.2)
       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.1)
+    async (2.14.2)
       console (~> 1.25, >= 1.25.2)
       fiber-annotation
       io-event (~> 1.6, >= 1.6.5)
@@ -35,7 +35,7 @@ GEM
     blake2b_rs (0.1.4)
       ffi (~> 1.0)
       thermite (~> 0)
-    console (1.25.2)
+    console (1.27.0)
       fiber-annotation
       fiber-local (~> 1.1)
       json
@@ -51,7 +51,7 @@ GEM
     json (2.7.2)
     minitar (0.9)
     protocol-hpack (1.4.3)
-    protocol-http (0.27.0)
+    protocol-http (0.28.1)
     protocol-http1 (0.19.1)
       protocol-http (~> 0.22)
     protocol-http2 (0.18.0)

data/examples/ws_client_4.rb

@@ -3,11 +3,41 @@ require 'scale_rb'
 # ScaleRb.logger.level = Logger::DEBUG
 
 ScaleRb::WsClient.start('wss://polkadot-rpc.dwellir.com') do |client|
-  client.chain_subscribeFinalizedHeads do |head|
-    block_number = head['number'].to_i(16)
-    block_hash = client.chain_getBlockHash(block_number)
+  block_number = 21711742
+  block_hash = client.chain_getBlockHash(block_number)
+  metadata = client.get_metadata(block_hash)
 
-    storage = client.get_storage(block_hash, 'System', 'Events')
-    puts "block #{block_number}(#{block_hash}) has #{storage.length} events"
-  end
+  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}}, ...]
+
+
+  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}}}
 end

data/lib/client/client_ext.rb

@@ -1,21 +1,29 @@
 module ScaleRb
+
+  # This module is used to add extra methods to both the ScaleRb::WsClient ScaleRb::HttpClient
   module ClientExt
-    def get_metadata(block_hash)
-      dir = ENV['SCALE_RB_METADATA_DIR'] || File.join(Dir.pwd, 'metadata')
+    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_metadata_by_block_hash(dir, block_hash)
+    # get decoded metadata at block_hash
+    def get_metadata(block_hash)
+      metadata_hex = state_getMetadata(block_hash)
+      ScaleRb::Metadata.decode_metadata(metadata_hex.strip._to_bytes)
     end
 
-    # get storage at block_hash
-    def get_storage(block_hash, pallet_name, storage_name, key_part1: nil, key_part2: nil)
-      metadata = get_metadata(block_hash)
+    # Get decoded storage at block_hash
+    def get_storage(block_hash, storage_query, metadata = nil)
+      metadata ||= get_metadata(block_hash)
 
       # storeage item
-      pallet_name = to_pascal pallet_name
-      storage_name = to_pascal storage_name
+      pallet_name = convert_to_camel_case storage_query.pallet_name
+      storage_name = convert_to_camel_case storage_query.storage_name
 
       # storage param
-      key = [key_part1, key_part2].compact
+      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}"
@@ -31,41 +39,6 @@ module ScaleRb
 
     private
 
-    def get_metadata_by_block_hash(cache_dir, block_hash)
-      # Get metadata from cache if it exists
-      runtime_version = state_getRuntimeVersion(block_hash)
-      spec_name = runtime_version['specName']
-      spec_version = runtime_version['specVersion']
-      metadata = cached_metadata(spec_name, spec_version, cache_dir)
-      return metadata if metadata
-
-      # Get metadata from node
-      metadata_hex = state_getMetadata(block_hash)
-      metadata = ScaleRb::Metadata.decode_metadata(metadata_hex.strip._to_bytes)
-
-      # cache it
-      save_metadata_to_file(spec_name, spec_version, metadata, cache_dir)
-
-      return metadata
-    end
-
-    def cached_metadata(spec_name, spec_version, dir)
-      file_path = File.join(dir, "#{spec_name}-#{spec_version}.json")
-      return unless File.exist?(file_path)
-
-      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 query_storage_at(block_hash, storage_keys, type_id, default, registry)
       result = state_queryStorageAt(storage_keys, block_hash)
       result.map do |item|
@@ -91,11 +64,11 @@ module ScaleRb
       storage_keys = get_storage_keys_by_partial_key(block_hash, partial_storage_key, partial_storage_key)
       storage_keys.each_slice(250).map do |slice|
         query_storage_at(
+          block_hash,
           slice,
           type_id_of_value,
           default,
-          registry,
-          block_hash
+          registry
         )
       end.flatten
     end
@@ -127,8 +100,10 @@ module ScaleRb
     #   },
     #   ..
     #
-    # TODO: part of the key is provided, but not all
+    # 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}"
+
       if key
         if key[:value].nil? || key[:value].empty?
           # map, but no key's value provided. get all storages under the partial storage key
@@ -150,15 +125,20 @@ module ScaleRb
             value[:modifier] == 'Default' ? value[:fallback] : nil,
             registry
           )
+        else
+          storage_key = StorageHelper.encode_storage_key(pallet_name, item_name, key, registry)._to_hex
+          data = state_getStorage(storage_key, block_hash)
+          StorageHelper.decode_storage(data, value[:type], value[:modifier] == 'Optional', value[:fallback], registry)
         end
       else
-        storage_key = StorageHelper.encode_storage_key(pallet_name, item_name, key, registry)._to_hex
+        storage_key = StorageHelper.encode_storage_key(pallet_name, item_name)._to_hex
         data = state_getStorage(storage_key, block_hash)
         StorageHelper.decode_storage(data, value[:type], value[:modifier] == 'Optional', value[:fallback], registry)
       end
     end
 
-    def get_storage2(block_hash, pallet_name, item_name, value_of_key, metadata)
+    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)
@@ -179,15 +159,12 @@ module ScaleRb
         if plain
           [
             nil,
-            { type: plain,
-              modifier: modifier, fallback: fallback }
+            { type: plain, modifier: modifier, fallback: fallback }
           ]
         elsif map
           [
-            { value: value_of_key,
-              type: map._get(:key), hashers: map._get(:hashers) },
-          { type: map._get(:value),
-            modifier: modifier, fallback: fallback }
+            { value: params, type: map._get(:key), hashers: map._get(:hashers) },
+            { type: map._get(:value), modifier: modifier, fallback: fallback }
           ]
         else
           raise 'NoSuchStorageType'
@@ -195,16 +172,17 @@ module ScaleRb
       get_storage1(block_hash, pallet_name, item_name, key, value, registry)
     end
 
-    def to_pascal(str)
-      str.split('_').collect(&:capitalize).join
+    def convert_to_camel_case(str)
+      words = str.split(/_|(?=[A-Z])/)
+      words.map(&:capitalize).join
     end
 
     # convert key to byte array
     def c(key)
-      if key.start_with?('0x')
-        key._to_bytes
-      elsif key.to_i.to_s == key # check if key is a number
+      if key.is_a?(Integer)
         key.to_i
+      elsif key.is_a?(String) && key.start_with?('0x')
+        key._to_bytes
       else
         key
       end

data/lib/scale_rb/version.rb

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

data/lib/storage_helper.rb

@@ -3,11 +3,7 @@
 module ScaleRb
   module StorageHelper
     class << self
-      # key: {
-      #   value: ,
-      #   type: ,
-      #   hashers: []
-      # }
+      # key example: {:value=>[0], :type=>4, :hashers=>["Twox64Concat"]}
       def encode_storage_key(pallet_name, item_name, key = nil, registry = nil)
         storage_key = Hasher.twox128(pallet_name) + Hasher.twox128(item_name)
 
@@ -15,16 +11,18 @@ module ScaleRb
 
           key_types, key_values, key_hashers =
             if key[:hashers].length == 1
+              # {:value=>[0], :type=>4, :hashers=>["Twox64Concat"]}
+              # type 4 is Uint32
               [
                 [key[:type]],
-                [key[:value]],
+                key[:value],
                 key[:hashers]
               ]
             else
               [
-                registry[key[:type]]._get(:def)._get(:tuple).first(key[:value].length),
+                registry[key[:type]]._get(:def)._get(:tuple),
                 key[:value],
-                key[:hashers].first(key[:value].length)
+                key[:hashers]
               ]
             end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scale_rb
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Aki Wu
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-16 00:00:00.000000000 Z
+date: 2024-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base58
@@ -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: []