scale_rb 0.1.14 → 0.1.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82a0911194368a4fcefec7a414694346f087c0ded749d3865f6732f27c8afef0
-  data.tar.gz: 14b34a748f835c527726ebd42440cced5ed8b5c0d954cb15c41e288ce3e5aff6
+  metadata.gz: d49c850c60bd8f6807d0c04995d3b8a5262f63dc627b585e683d774e91ed96ab
+  data.tar.gz: adbba1bbba8cf9bbf3f559893a2b69f90d94a41a259db713f1a7db6dcb83b29f
 SHA512:
-  metadata.gz: 805efca604cc93794b5c1d4ee3dd1785d74d6a049b55f0ecc0503c85869c2759a37380b6735b8ecf874b6b33b31492f7b203870b7b414758740545821f98db19
-  data.tar.gz: d5f577ec96adf7a51ef7044b0d5f8bc874e3a12daf66e3cc743677a6a095ddda909267b941dd15a06646dc941caeabe810fd960140c1c94261d173796ee40b9d
+  metadata.gz: b0b06fa722621edab033346e30d78ea8096d98fe032f285845f2685593b6cce266aaa18cd8126cdf1632b1e85f6bcdeea6e6858c12534608ab7fb98a27dbd777
+  data.tar.gz: e57dc6323f7bd0024041ce0ed46bcc006f588e770f895d530d836755981248e1d37abf4d33c529da0e5db57dac231a941bcd506a8822170b8f074b72ba4877cc

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    scale_rb (0.1.14)
+    scale_rb (0.1.15)
       base58
       blake2b_rs (~> 0.1.4)
       xxhash

data/lib/client/http_client.rb

@@ -4,6 +4,7 @@ require 'uri'
 require 'net/http'
 require 'json'
 require_relative './http_client_metadata'
+require_relative './http_client_storage'
 
 # TODO: method_name = cmd.gsub(/([a-z\d])([A-Z])/, '\1_\2').downcase
 module ScaleRb
@@ -60,176 +61,6 @@ module ScaleRb
         result = json_rpc_call(url, 'rpc_methods', [])
         result['methods']
       end
-
-      def get_metadata(url, at = nil)
-        hex = state_getMetadata(url, at)
-        Metadata.decode_metadata(hex.strip.to_bytes)
-      end
-
-      def query_storage_at(url, storage_keys, type_id, default, registry, at = nil)
-        result = state_queryStorageAt(url, storage_keys, at)
-        result.map do |item|
-          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]
-            { storage_key: storage_key, storage: storage }
-          end
-        end.flatten
-      end
-
-      def get_storage_keys_by_partial_key(url, partial_storage_key, start_key = nil, at = nil)
-        storage_keys = state_getKeysPaged(url, partial_storage_key, 1000, start_key, at)
-        if storage_keys.length == 1000
-          storage_keys + get_storage_keys_by_partial_key(url, partial_storage_key, storage_keys.last, at)
-        else
-          storage_keys
-        end
-      end
-
-      def get_storages_by_partial_key(url, partial_storage_key, type_id_of_value, default, registry, at = nil)
-        storage_keys = get_storage_keys_by_partial_key(url, partial_storage_key, partial_storage_key, at)
-        storage_keys.each_slice(250).map do |slice|
-          query_storage_at(
-            url,
-            slice,
-            type_id_of_value,
-            default,
-            registry,
-            at
-          )
-        end.flatten
-      end
-
-      # 1. Plain
-      #   key:   nil
-      #   value: { type: 3, modifier: 'Default', callback: '' }
-      #
-      # 2. Map
-      #   key:   { value: value, type: 0, hashers: ['Blake2128Concat'] }
-      #   value: { type: 3, modifier: 'Default', callback: '' }
-      #
-      # 3. Map, but key.value is nil
-      #   key:   { value: nil, type: 0, hashers: ['Blake2128Concat'] }
-      #   value: { type: 3, modifier: 'Default', callback: '' }
-      #
-      # example:
-      #   'System',
-      #   'Account',
-      #   key = {
-      #     value: [['0x724d50824542b56f422588421643c4a162b90b5416ef063f2266a1eae6651641'.to_bytes]], # [AccountId]
-      #     type: 0,
-      #     hashers: ['Blake2128Concat']
-      #   },
-      #   value = {
-      #     type: 3,
-      #     modifier: 'Default',
-      #     callback: '0x0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000'
-      #   },
-      #   ..
-      #
-      # TODO: part of the key is provided, but not all
-      def get_storage(url, pallet_name, item_name, key, value, registry, at = nil)
-        if key
-          if key[:value].nil? || key[:value].empty?
-            # map, but no key's value provided. get all storages under the partial storage key
-            partial_storage_key = StorageHelper.encode_storage_key(pallet_name, item_name).to_hex
-            get_storages_by_partial_key(
-              url,
-              partial_storage_key,
-              value[:type],
-              value[:modifier] == 'Default' ? value[:fallback] : nil,
-              registry,
-              at
-            )
-          elsif key[:value].length != key[:hashers].length
-            # map with multi part, but only provide part value
-            partial_storage_key = StorageHelper.encode_storage_key(pallet_name, item_name, key, registry).to_hex
-            get_storages_by_partial_key(
-              url,
-              partial_storage_key,
-              value[:type],
-              value[:modifier] == 'Default' ? value[:fallback] : nil,
-              registry,
-              at
-            )
-          end
-        else
-          storage_key = StorageHelper.encode_storage_key(pallet_name, item_name, key, registry).to_hex
-          data = state_getStorage(url, storage_key, at)
-          StorageHelper.decode_storage(data, value[:type], value[:modifier] == 'Optional', value[:fallback], registry)
-        end
-      end
-
-      def get_storage2(url, pallet_name, item_name, value_of_key, metadata, at = nil)
-        raise 'Metadata should not be nil' if metadata.nil?
-
-        registry = Metadata.build_registry(metadata)
-        item = Metadata.get_storage_item(pallet_name, item_name, metadata)
-        raise "No such storage item: `#{pallet_name}`.`#{item_name}`" if item.nil?
-
-        modifier = item._get(:modifier) # Default | Optional
-        fallback = item._get(:fallback)
-        type = item._get(:type)
-
-        plain = type._get(:plain)
-        map = type._get(:map)
-        # debug
-
-        key, value =
-          if plain
-            [
-              nil,
-              { 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 }
-            ]
-          else
-            raise 'NoSuchStorageType'
-          end
-        get_storage(url, pallet_name, item_name, key, value, registry, at)
-      end
-
-      # get_storage3 is a more ruby style function
-      #
-      # pallet_name and storage_name is pascal style like 'darwinia_staking'
-      def get_storage3(url, metadata, pallet_name, storage_name, key_part1: nil, key_part2: nil, at: nil)
-        pallet_name = to_pascal pallet_name
-        storage_name = to_pascal storage_name
-        ScaleRb.logger.debug "#{pallet_name}.#{storage_name}(#{[key_part1, key_part2].compact.join(', ')})"
-
-        key = [key_part1, key_part2].compact.map { |part_of_key| c(part_of_key) }
-        ScaleRb.logger.debug "converted key: #{key}"
-
-        get_storage2(
-          url,
-          pallet_name,
-          storage_name,
-          key,
-          metadata,
-          at
-        )
-      end
-
-      private
-
-      def to_pascal(str)
-        str.split('_').collect(&: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
-          key.to_i
-        else
-          key
-        end
-      end
     end
   end
 end

data/lib/client/http_client_metadata.rb

@@ -4,14 +4,16 @@ 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: File.join(Dir.pwd, 'metadata'))
-        # if at
-        #   require_block_hash_correct(url, at)
-        # else
-        #   at = ScaleRb::HttpClient.chain_getFinalizedHead(url)
-        # end
+      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)
 
@@ -27,7 +29,7 @@ module ScaleRb
         metadata = ScaleRb::HttpClient.get_metadata(url, at)
 
         # cache it
-        puts "caching metadata `#{spec_name}_#{spec_version}.json`"
+        ScaleRb.logger.debug "caching metadata `#{spec_name}_#{spec_version}.json`"
         save_metadata_to_file(
           spec_name: spec_name,
           spec_version: spec_version,
@@ -54,7 +56,7 @@ module ScaleRb
         file_path = File.join(dir, "#{spec_name}_#{spec_version}.json")
         return unless File.exist?(file_path)
 
-        puts "found metadata `#{spec_name}_#{spec_version}.json` in cache"
+        ScaleRb.logger.debug "found metadata `#{spec_name}_#{spec_version}.json` in cache"
         JSON.parse(File.read(file_path))
       end
 

data/lib/client/http_client_storage.rb

@@ -0,0 +1,180 @@
+module ScaleRb
+  module HttpClient
+    class << self
+      # get_storage3 is a more ruby style function
+      #
+      # pallet_name and storage_name is pascal style like 'darwinia_staking'
+      def get_storage3(url, pallet_name, storage_name, key_part1: nil, key_part2: nil, metadata: nil, at: nil)
+        # Get metadata if not provided, and cache it.
+        # The default dir is `metadata` dir under the caller's dir.
+        # You can change it by setting `SCALE_RB_METADATA_DIR` env variable
+        metadata = get_metadata_cached(url, at: at) if metadata.nil?
+
+        pallet_name = to_pascal pallet_name
+        storage_name = to_pascal storage_name
+        ScaleRb.logger.debug "#{pallet_name}.#{storage_name}(#{[key_part1, key_part2].compact.join(', ')})"
+
+        key = [key_part1, key_part2].compact.map { |part_of_key| c(part_of_key) }
+        ScaleRb.logger.debug "converted key: #{key}"
+
+        get_storage2(
+          url,
+          pallet_name,
+          storage_name,
+          key,
+          metadata,
+          at
+        )
+      end
+
+      private
+
+      def query_storage_at(url, storage_keys, type_id, default, registry, at = nil)
+        result = state_queryStorageAt(url, storage_keys, at)
+        result.map do |item|
+          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]
+            { storage_key: storage_key, storage: storage }
+          end
+        end.flatten
+      end
+
+      def get_storage_keys_by_partial_key(url, partial_storage_key, start_key = nil, at = nil)
+        storage_keys = state_getKeysPaged(url, partial_storage_key, 1000, start_key, at)
+        if storage_keys.length == 1000
+          storage_keys + get_storage_keys_by_partial_key(url, partial_storage_key, storage_keys.last, at)
+        else
+          storage_keys
+        end
+      end
+
+      def get_storages_by_partial_key(url, partial_storage_key, type_id_of_value, default, registry, at = nil)
+        storage_keys = get_storage_keys_by_partial_key(url, partial_storage_key, partial_storage_key, at)
+        storage_keys.each_slice(250).map do |slice|
+          query_storage_at(
+            url,
+            slice,
+            type_id_of_value,
+            default,
+            registry,
+            at
+          )
+        end.flatten
+      end
+
+      # 1. Plain
+      #   key:   nil
+      #   value: { type: 3, modifier: 'Default', callback: '' }
+      #
+      # 2. Map
+      #   key:   { value: value, type: 0, hashers: ['Blake2128Concat'] }
+      #   value: { type: 3, modifier: 'Default', callback: '' }
+      #
+      # 3. Map, but key.value is nil
+      #   key:   { value: nil, type: 0, hashers: ['Blake2128Concat'] }
+      #   value: { type: 3, modifier: 'Default', callback: '' }
+      #
+      # example:
+      #   'System',
+      #   'Account',
+      #   key = {
+      #     value: [['0x724d50824542b56f422588421643c4a162b90b5416ef063f2266a1eae6651641'.to_bytes]], # [AccountId]
+      #     type: 0,
+      #     hashers: ['Blake2128Concat']
+      #   },
+      #   value = {
+      #     type: 3,
+      #     modifier: 'Default',
+      #     callback: '0x0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000'
+      #   },
+      #   ..
+      #
+      # TODO: part of the key is provided, but not all
+      def get_storage(url, pallet_name, item_name, key, value, registry, at = nil)
+        if key
+          if key[:value].nil? || key[:value].empty?
+            # map, but no key's value provided. get all storages under the partial storage key
+            partial_storage_key = StorageHelper.encode_storage_key(pallet_name, item_name).to_hex
+            get_storages_by_partial_key(
+              url,
+              partial_storage_key,
+              value[:type],
+              value[:modifier] == 'Default' ? value[:fallback] : nil,
+              registry,
+              at
+            )
+          elsif key[:value].length != key[:hashers].length
+            # map with multi parts, but not have all values
+            partial_storage_key = StorageHelper.encode_storage_key(pallet_name, item_name, key, registry).to_hex
+            get_storages_by_partial_key(
+              url,
+              partial_storage_key,
+              value[:type],
+              value[:modifier] == 'Default' ? value[:fallback] : nil,
+              registry,
+              at
+            )
+          end
+        else
+          storage_key = StorageHelper.encode_storage_key(pallet_name, item_name, key, registry).to_hex
+          data = state_getStorage(url, storage_key, at)
+          StorageHelper.decode_storage(data, value[:type], value[:modifier] == 'Optional', value[:fallback], registry)
+        end
+      end
+
+      def get_storage2(url, pallet_name, item_name, value_of_key, metadata, at = nil)
+        raise 'Metadata should not be nil' if metadata.nil?
+
+        registry = Metadata.build_registry(metadata)
+        item = Metadata.get_storage_item(
+          pallet_name, item_name, metadata
+        )
+        raise "No such storage item: `#{pallet_name}`.`#{item_name}`" if item.nil?
+
+        modifier = item._get(:modifier) # Default | Optional
+        fallback = item._get(:fallback)
+        type = item._get(:type)
+
+        plain = type._get(:plain)
+        map = type._get(:map)
+        # debug
+
+        key, value =
+          if plain
+            [
+              nil,
+              { 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 }
+            ]
+          else
+            raise 'NoSuchStorageType'
+          end
+        get_storage(url, pallet_name, item_name, key, value, registry, at)
+      end
+
+      def to_pascal(str)
+        str.split('_').collect(&: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
+          key.to_i
+        else
+          key
+        end
+      end
+    end
+  end
+end

data/lib/codec.rb

@@ -191,9 +191,9 @@ module ScaleRb
   # Decode
   class << self
     def decode(type, bytes, registry = {})
-      logger.debug '--------------------------------------------------'
-      debug 'decoding type', type
-      debug 'bytes', bytes&.length
+      # logger.debug '--------------------------------------------------'
+      # debug 'decoding type', type
+      # debug 'bytes', bytes&.length
 
       if type.instance_of?(String)
         return decode_bytes(bytes) if bytes?(type) # Bytes
@@ -221,8 +221,8 @@ module ScaleRb
     def decode_bytes(bytes)
       length, remaining_bytes = _do_decode_compact(bytes)
       value = remaining_bytes[0...length].to_hex
-      debug 'length', length
-      debug 'value', value
+      # debug 'length', length
+      # debug 'value', value
       [
         value,
         remaining_bytes[length..]
@@ -238,7 +238,7 @@ module ScaleRb
         else
           raise InvalidBytesError, 'type: Boolean'
         end
-      debug 'value', value
+      # debug 'value', value
       [value, bytes[1..]]
     end
 
@@ -247,8 +247,8 @@ module ScaleRb
       raise NotEnoughBytesError, 'type: String' if remaining_bytes.length < length
 
       value = remaining_bytes[0...length].to_utf8
-      debug 'byte length', length
-      debug 'value', value.inspect
+      # debug 'byte length', length
+      # debug 'value', value.inspect
       [
         value,
         remaining_bytes[length..]
@@ -261,7 +261,7 @@ module ScaleRb
       raise NotEnoughBytesError, "type: #{type}" if bytes.length < byte_length
 
       value = bytes[0...byte_length].flip.to_int(bit_length)
-      debug 'value', value
+      # debug 'value', value
       [
         value,
         bytes[byte_length..]
@@ -274,7 +274,7 @@ module ScaleRb
       raise NotEnoughBytesError, "type: #{type_def}" if bytes.length < byte_length
 
       value = bytes[0...byte_length].flip.to_uint
-      debug 'value', value
+      # debug 'value', value
       [
         value,
         bytes[byte_length..]
@@ -282,9 +282,8 @@ module ScaleRb
     end
 
     def decode_compact(bytes)
-      result = _do_decode_compact(bytes)
-      debug 'value', result[0]
-      result
+      _do_decode_compact(bytes)
+      # debug 'value', result[0]
     end
 
     def decode_option(type_def, bytes, registry = {})
@@ -304,7 +303,7 @@ module ScaleRb
     def decode_vec(type_def, bytes, registry = {})
       inner_type = parse_vec(type_def)
       length, remaining_bytes = _do_decode_compact(bytes)
-      debug 'length', length
+      # debug 'length', length
       _decode_types([inner_type] * length, remaining_bytes, registry)
     end
 
@@ -331,7 +330,7 @@ module ScaleRb
       raise IndexOutOfRangeError, "type: #{type_def}" if index > items.length - 1
 
       item = items.to_a[index] # 'name' or [:name, inner_type]
-      debug 'value', item.inspect
+      # debug 'value', item.inspect
       return [item, bytes[1..]] if item.instance_of?(String)
 
       value, remaining_bytes = decode(item[1], bytes[1..], registry)
@@ -353,9 +352,9 @@ module ScaleRb
   # Encode
   class << self
     def encode(type, value, registry = {})
-      logger.debug '--------------------------------------------------'
-      debug 'encoding type', type
-      debug 'value', value
+      # logger.debug '--------------------------------------------------'
+      # debug 'encoding type', type
+      # debug 'value', value
 
       if type.instance_of?(String)
         return encode_bytes(value) if bytes?(type)

data/lib/scale_rb/version.rb

@@ -1,3 +1,3 @@
 module ScaleRb
-  VERSION = '0.1.14'
+  VERSION = '0.1.15'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scale_rb
 version: !ruby/object:Gem::Version
-  version: 0.1.14
+  version: 0.1.15
 platform: ruby
 authors:
 - Aki Wu
@@ -77,6 +77,7 @@ files:
 - lib/client/abstract_ws_client.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/codec.rb
 - lib/hasher.rb