scale_rb 0.1.11 → 0.1.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9af24645257f5dc7c2028047ba01ef9a3d1fe4282581717cb62334a6f96f153
-  data.tar.gz: 8d79a47702d593158680d4fe2f5a887962fd87bc19e51e2d57b4ea6ca2ec0a9b
+  metadata.gz: 82a0911194368a4fcefec7a414694346f087c0ded749d3865f6732f27c8afef0
+  data.tar.gz: 14b34a748f835c527726ebd42440cced5ed8b5c0d954cb15c41e288ce3e5aff6
 SHA512:
-  metadata.gz: b573f530576618d07382f3b995cc5413a564e4bf95149882cc83b6cb0d885e2adee2f903b5db0c8a14fd5b6964683b6851f6105e0c53c6bcb98e625c2991a639
-  data.tar.gz: efa796fe20f73749749bfd06de0f08c1d836268ddb99963775003f282eff60e15accd4d62556eaa1d01b0821447bdcb4bd8956e5445401ca562da2df1fc547f8
+  metadata.gz: 805efca604cc93794b5c1d4ee3dd1785d74d6a049b55f0ecc0503c85869c2759a37380b6735b8ecf874b6b33b31492f7b203870b7b414758740545821f98db19
+  data.tar.gz: d5f577ec96adf7a51ef7044b0d5f8bc874e3a12daf66e3cc743677a6a095ddda909267b941dd15a06646dc941caeabe810fd960140c1c94261d173796ee40b9d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    scale_rb (0.1.11)
+    scale_rb (0.1.14)
       base58
       blake2b_rs (~> 0.1.4)
       xxhash
@@ -14,7 +14,7 @@ GEM
       ffi (~> 1.0)
       thermite (~> 0)
     diff-lcs (1.5.0)
-    ffi (1.15.5)
+    ffi (1.16.3)
     minitar (0.9)
     rake (12.3.3)
     rspec (3.11.0)

data/lib/address.rb

@@ -14,7 +14,7 @@ class Address
     # Darwinia Live
     18,
     # Dothereum (SS58, AccountId)
-    20, 21, 
+    20, 21,
     # Generic Substrate wildcard (SS58, AccountId)
     42, 43,
 
@@ -30,54 +30,62 @@ class Address
   ]
 
   class << self
-
     def array_to_hex_string(arr)
       body = arr.map { |i| i.to_s(16).rjust(2, '0') }.join
       "0x#{body}"
     end
 
-    def decode(address, addr_type = 42, ignore_checksum = true)
+    def decode(address, addr_type = 42, _ignore_checksum = true)
       decoded = Base58.base58_to_binary(address, :bitcoin)
       is_pubkey = decoded.size == 35
 
-      size = decoded.size - ( is_pubkey ? 2 : 1 )
+      size = decoded.size - (is_pubkey ? 2 : 1)
+
+      prefix = decoded[0, 1].unpack1('C*')
 
-      prefix = decoded[0, 1].unpack("C*").first
+      raise 'Invalid address type' unless TYPES.include?(addr_type)
 
-      raise "Invalid address type" unless TYPES.include?(addr_type)
-      
       hash_bytes = make_hash(decoded[0, size])
-      if is_pubkey
-        is_valid_checksum = decoded[-2].unpack("C*").first == hash_bytes[0] && decoded[-1].unpack("C*").first == hash_bytes[1]
-      else
-        is_valid_checksum = decoded[-1].unpack("C*").first == hash_bytes[0]
-      end
+      is_valid_checksum =
+        if is_pubkey
+          decoded[-2].unpack1('C*') == hash_bytes[0] && decoded[-1].unpack1('C*') == hash_bytes[1]
+        else
+          decoded[-1].unpack1('C*') == hash_bytes[0]
+        end
 
       # raise "Invalid decoded address checksum" unless is_valid_checksum && ignore_checksum
 
-      decoded[1...size].unpack("H*").first
+      decoded[1...size].unpack1('H*')
     end
 
-
     def encode(pubkey, addr_type = 42)
       pubkey = pubkey[2..-1] if pubkey =~ /^0x/i
-      key = [pubkey].pack("H*")
-
-      u8_array = key.bytes
-
-      u8_array.unshift(addr_type)
-
-      bytes = make_hash(u8_array.pack("C*"))
-      
-      checksum = bytes[0, key.size == 32 ? 2 : 1]
-
-      u8_array.push(*checksum)
-
-      u8_array = u8_array.map { |i| if i.is_a?(String) then i.to_i(16) else i end }
-      # u8_array = [42, 202, 122, 179, 154, 86, 153, 242, 157, 207, 38, 115, 170, 163, 73, 75, 72, 81, 26, 186, 224, 220, 60, 101, 15, 243, 152, 246, 95, 229, 225, 18, 56, 0x7e]
-      input = u8_array.pack("C*")
-
-      Base58.binary_to_base58(input, :bitcoin)
+      key = [pubkey].pack('H*')
+
+      pubkey_bytes = key.bytes
+
+      checksum_length = case pubkey_bytes.length
+                        when 32, 33
+                          2
+                        when 1, 2, 4, 8
+                          1
+                        else
+                          raise 'Invalid pubkey length'
+                        end
+
+      ss58_format_bytes = if addr_type < 64
+                            [addr_type].pack('C*')
+                          else
+                            [
+                              ((ss58_format & 0b0000_0000_1111_1100) >> 2) | 0b0100_0000,
+                              (ss58_format >> 8) | ((ss58_format & 0b0000_0000_0000_0011) << 6)
+                            ].pack('C*')
+                          end
+
+      input_bytes = ss58_format_bytes.bytes + pubkey_bytes
+      checksum = Blake2b.hex(SS58_PREFIX.bytes + input_bytes, 64).to_bytes
+
+      Base58.binary_to_base58((input_bytes + checksum[0...checksum_length]).pack('C*'), :bitcoin)
     end
 
     def make_hash(body)
@@ -87,11 +95,11 @@ class Address
     def is_ss58_address?(address)
       begin
         decode(address)
-      rescue
+      rescue StandardError
         return false
       end
-      return true
+      true
     end
-
   end
-end
+end
+

data/lib/client/http_client.rb

@@ -3,6 +3,7 @@
 require 'uri'
 require 'net/http'
 require 'json'
+require_relative './http_client_metadata'
 
 # TODO: method_name = cmd.gsub(/([a-z\d])([A-Z])/, '\1_\2').downcase
 module ScaleRb
@@ -129,17 +130,30 @@ module ScaleRb
       #
       # TODO: part of the key is provided, but not all
       def get_storage(url, pallet_name, item_name, key, value, registry, at = nil)
-        # map, but no key's value provided. get all storages under the partial storage key
-        if key && (key[:value].nil? || key[:value].empty?)
-          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
-          )
+        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)
@@ -178,6 +192,44 @@ module ScaleRb
           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

@@ -0,0 +1,76 @@
+require 'json'
+require 'fileutils'
+
+module ScaleRb
+  module HttpClient
+    class << self
+      # 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
+        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
+        puts "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)
+
+        puts "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

data/lib/scale_rb/version.rb

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

data/lib/storage_helper.rb

@@ -12,26 +12,26 @@ module StorageHelper
 
       if key && registry
 
-        key_types, key_values =
+        key_types, key_values, key_hashers =
           if key[:hashers].length == 1
             [
               [key[:type]],
-              key[:value]
+              key[:value],
+              key[:hashers]
             ]
           else
             [
-              registry[key[:type]]._get(:def)._get(:tuple),
-              key[:value]
+              registry[key[:type]]._get(:def)._get(:tuple).first(key[:value].length),
+              key[:value],
+              key[:hashers].first(key[:value].length)
             ]
           end
 
-        # debug
-        # p "encode_storage_key -----------------------"
-        # p key_types
-        # p key_values
-        # p "encode_storage_key -----------------------"
-        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." if key_types.class != key_values.class || key_types.length != key_values.length
-        storage_key + PortableCodec._encode_types_with_hashers(key_types, key_values, registry, key[:hashers])
+        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
+
+        storage_key + PortableCodec._encode_types_with_hashers(key_types, key_values, registry, key_hashers)
       else
         storage_key
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scale_rb
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.1.14
 platform: ruby
 authors:
 - Aki Wu
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-08-21 00:00:00.000000000 Z
+date: 2023-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: blake2b_rs
@@ -76,6 +76,7 @@ files:
 - lib/address.rb
 - lib/client/abstract_ws_client.rb
 - lib/client/http_client.rb
+- lib/client/http_client_metadata.rb
 - lib/client/rpc_request_builder.rb
 - lib/codec.rb
 - lib/hasher.rb