scale_rb 0.1.15 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d49c850c60bd8f6807d0c04995d3b8a5262f63dc627b585e683d774e91ed96ab
-  data.tar.gz: adbba1bbba8cf9bbf3f559893a2b69f90d94a41a259db713f1a7db6dcb83b29f
+  metadata.gz: 204c629856c37264a38451c2655c36ea33aee9d97cb4220ab2d107dc692f1d79
+  data.tar.gz: 4e16a199f0d77c5a7fa4150e05a00204f3244cb33d64ec79604f7e19ff43fbc3
 SHA512:
-  metadata.gz: b0b06fa722621edab033346e30d78ea8096d98fe032f285845f2685593b6cce266aaa18cd8126cdf1632b1e85f6bcdeea6e6858c12534608ab7fb98a27dbd777
-  data.tar.gz: e57dc6323f7bd0024041ce0ed46bcc006f588e770f895d530d836755981248e1d37abf4d33c529da0e5db57dac231a941bcd506a8822170b8f074b72ba4877cc
+  metadata.gz: 5de7ac76c8a4113b2ae965845b2d7a940eabce3b732fad370a6bd1be039f83c0f251525c35ebace750493c07d4372868bc82fefcbd215f19c30b8702cf2ab281
+  data.tar.gz: a5796129a92d7bfca3d00cbdccf56a7574e3486d9562ef088ef74b5a24135cdbe6a3ee014692df2ba1bfbc3140dcd97a5d96bf575d73310eacabbde3e8876229

data/Gemfile.lock

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

data/lib/address.rb

@@ -1,105 +1,101 @@
 require 'base58'
 
 # Warning: Just for test
-class Address
-  SS58_PREFIX = 'SS58PRE'
-
-  TYPES = [
-    # Polkadot Live (SS58, AccountId)
-    0, 1,
-    # Polkadot Canary (SS58, AccountId)
-    2, 3,
-    # Kulupu (SS58, Reserved)
-    16, 17,
-    # Darwinia Live
-    18,
-    # Dothereum (SS58, AccountId)
-    20, 21,
-    # Generic Substrate wildcard (SS58, AccountId)
-    42, 43,
-
-    # Schnorr/Ristretto 25519 ("S/R 25519") key
-    48,
-    # Edwards Ed25519 key
-    49,
-    # ECDSA SECP256k1 key
-    50,
-
-    # Reserved for future address format extensions.
-    *64..255
-  ]
-
-  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)
-      decoded = Base58.base58_to_binary(address, :bitcoin)
-      is_pubkey = decoded.size == 35
-
-      size = decoded.size - (is_pubkey ? 2 : 1)
-
-      prefix = decoded[0, 1].unpack1('C*')
-
-      raise 'Invalid address type' unless TYPES.include?(addr_type)
-
-      hash_bytes = make_hash(decoded[0, size])
-      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].unpack1('H*')
-    end
-
-    def encode(pubkey, addr_type = 42)
-      pubkey = pubkey[2..-1] if pubkey =~ /^0x/i
-      key = [pubkey].pack('H*')
+module ScaleRb
+  class Address
+    SS58_PREFIX = 'SS58PRE'
+
+    TYPES = [
+      # Polkadot Live (SS58, AccountId)
+      0, 1,
+      # Polkadot Canary (SS58, AccountId)
+      2, 3,
+      # Kulupu (SS58, Reserved)
+      16, 17,
+      # Darwinia Live
+      18,
+      # Dothereum (SS58, AccountId)
+      20, 21,
+      # Generic Substrate wildcard (SS58, AccountId)
+      42, 43,
+
+      # Schnorr/Ristretto 25519 ("S/R 25519") key
+      48,
+      # Edwards Ed25519 key
+      49,
+      # ECDSA SECP256k1 key
+      50,
+
+      # Reserved for future address format extensions.
+      *64..255
+    ]
+
+    class << self
+      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)
+
+        prefix = decoded[0, 1].unpack1('C*')
+
+        raise 'Invalid address type' unless TYPES.include?(addr_type)
+
+        hash_bytes = make_hash(decoded[0, size])
+        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].unpack1('H*')
+      end
 
-      pubkey_bytes = key.bytes
+      def encode(pubkey, addr_type = 42)
+        pubkey = pubkey[2..-1] if pubkey =~ /^0x/i
+        key = [pubkey].pack('H*')
 
-      checksum_length = case pubkey_bytes.length
-                        when 32, 33
-                          2
-                        when 1, 2, 4, 8
-                          1
-                        else
-                          raise 'Invalid pubkey length'
-                        end
+        pubkey_bytes = key.bytes
 
-      ss58_format_bytes = if addr_type < 64
-                            [addr_type].pack('C*')
+        checksum_length = case pubkey_bytes.length
+                          when 32, 33
+                            2
+                          when 1, 2, 4, 8
+                            1
                           else
-                            [
-                              ((ss58_format & 0b0000_0000_1111_1100) >> 2) | 0b0100_0000,
-                              (ss58_format >> 8) | ((ss58_format & 0b0000_0000_0000_0011) << 6)
-                            ].pack('C*')
+                            raise 'Invalid pubkey length'
                           end
 
-      input_bytes = ss58_format_bytes.bytes + pubkey_bytes
-      checksum = Blake2b.hex(SS58_PREFIX.bytes + input_bytes, 64).to_bytes
+        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
 
-      Base58.binary_to_base58((input_bytes + checksum[0...checksum_length]).pack('C*'), :bitcoin)
-    end
+        input_bytes = ss58_format_bytes.bytes + pubkey_bytes
+        checksum = Blake2b.hex(SS58_PREFIX.bytes + input_bytes, 64)._to_bytes
 
-    def make_hash(body)
-      Blake2b.hex("#{SS58_PREFIX}#{body}".bytes, 64)
-    end
+        Base58.binary_to_base58((input_bytes + checksum[0...checksum_length]).pack('C*'), :bitcoin)
+      end
 
-    def is_ss58_address?(address)
-      begin
-        decode(address)
-      rescue StandardError
-        return false
+      def make_hash(body)
+        Blake2b.hex("#{SS58_PREFIX}#{body}".bytes, 64)
+      end
+
+      def is_ss58_address?(address)
+        begin
+          decode(address)
+        rescue StandardError
+          return false
+        end
+        true
       end
-      true
     end
   end
 end
-

data/lib/client/abstract_ws_client.rb

@@ -1,100 +1,104 @@
 # frozen_string_literal: true
 
-class AbstractWsClient
-  extend RpcRequestBuilder
-  attr_accessor :metadata, :registry
-
-  def initialize
-    @id = 0
-    @metadata = nil
-    @registry = nil
-    @callbacks = {}
-    @subscription_callbacks = {}
-  end
+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
+    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
+    # 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
+    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_hex = resp['result']
+          metadata = Metadata.decode_metadata(metadata_hex.strip._to_bytes)
+          return unless metadata
 
-        @metadata = metadata
-        @registry = Metadata.build_registry(@metadata)
+          @metadata = metadata
+          @registry = Metadata.build_registry(@metadata)
+        end
       end
-    end
 
-    id = bind_id_to(callback)
-    body = state_getMetadata(id)
-    send_json_rpc(body)
-  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
+    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
+    private
 
-  def bind_id_to(callback)
-    @callbacks[@id] = callback
-    old = @id
-    @id += 1
-    old
-  end
+    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)
+    def decode_storages(datas, storage_item, registry)
+      datas.map do |data|
+        StorageHelper.decode_storage2(data, storage_item, registry)
+      end
     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
+    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
-      ]
+        @subscription_callbacks[resp['result']] = [
+          pallet_name,
+          item_name,
+          subscription_callback
+        ]
+      end
     end
   end
 end

data/lib/client/http_client.rb

@@ -3,6 +3,7 @@
 require 'uri'
 require 'net/http'
 require 'json'
+require_relative './rpc_request_builder'
 require_relative './http_client_metadata'
 require_relative './http_client_storage'
 
@@ -12,7 +13,7 @@ module ScaleRb
     extend RpcRequestBuilder
 
     class << self
-      def request(url, body)
+      def request(url, body, tries = 0)
         ScaleRb.logger.debug "url: #{url}"
         ScaleRb.logger.debug "body: #{body}"
         uri = URI(url)
@@ -30,10 +31,12 @@ module ScaleRb
 
         result['result']
       rescue StandardError => e
+        raise e unless tries < 5
+
         ScaleRb.logger.error e.message
-        ScaleRb.logger.error 'retry...'
-        sleep 2
-        request(url, body)
+        ScaleRb.logger.error 'retry after 5 seconds...'
+        sleep 5
+        request(url, body, tries + 1)
       end
 
       def json_rpc_call(url, method, *params)
@@ -64,3 +67,31 @@ module ScaleRb
     end
   end
 end
+
+# https://polkadot.js.org/docs/substrate/rpc/
+#
+# Examples:
+# # Get all supported rpc methods
+# ScaleRb::HttpClient.rpc_methods("https://rpc.darwinia.network")
+#
+# # eth_blockNumber
+# ScaleRb::HttpClient.eth_blockNumber("https://rpc.darwinia.network")
+#
+# # system_name
+# ScaleRb::HttpClient.system_name("https://rpc.darwinia.network")
+#
+# # chain_getHead
+# ScaleRb::HttpClient.chain_getHead("https://rpc.darwinia.network")
+#
+# # state_getMetadata of darwinia block #1582
+# ScaleRb::HttpClient.state_getMetadata(
+#   "https://rpc.darwinia.network",
+#   "0xb5a4f16d0feba7531e75315432b4d31a5b918987e026437890a2cbf5b8d9956d"
+# )
+#
+# # eth_getBalance of address 0x0000000000000000000000000000000000000000 at block #1582
+# ScaleRb::HttpClient.eth_getBalance(
+#   "https://rpc.darwinia.network",
+#   "0x0000000000000000000000000000000000000000",
+#   1582
+# )

data/lib/client/http_client_metadata.rb

@@ -6,7 +6,7 @@ module ScaleRb
     class << self
       def get_metadata(url, at = nil)
         hex = state_getMetadata(url, at)
-        Metadata.decode_metadata(hex.strip.to_bytes)
+        Metadata.decode_metadata(hex.strip._to_bytes)
       end
 
       # cached version of get_metadata

data/lib/client/http_client_storage.rb

@@ -35,7 +35,7 @@ module ScaleRb
           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 = data.nil? ? nil : PortableCodec.decode(type_id, data._to_bytes, registry)[0]
             { storage_key: storage_key, storage: storage }
           end
         end.flatten
@@ -80,7 +80,7 @@ module ScaleRb
       #   'System',
       #   'Account',
       #   key = {
-      #     value: [['0x724d50824542b56f422588421643c4a162b90b5416ef063f2266a1eae6651641'.to_bytes]], # [AccountId]
+      #     value: [['0x724d50824542b56f422588421643c4a162b90b5416ef063f2266a1eae6651641'._to_bytes]], # [AccountId]
       #     type: 0,
       #     hashers: ['Blake2128Concat']
       #   },
@@ -96,7 +96,7 @@ module ScaleRb
         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
+            partial_storage_key = StorageHelper.encode_storage_key(pallet_name, item_name)._to_hex
             get_storages_by_partial_key(
               url,
               partial_storage_key,
@@ -107,7 +107,7 @@ module ScaleRb
             )
           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
+            partial_storage_key = StorageHelper.encode_storage_key(pallet_name, item_name, key, registry)._to_hex
             get_storages_by_partial_key(
               url,
               partial_storage_key,
@@ -118,7 +118,7 @@ module ScaleRb
             )
           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, key, registry)._to_hex
           data = state_getStorage(url, storage_key, at)
           StorageHelper.decode_storage(data, value[:type], value[:modifier] == 'Optional', value[:fallback], registry)
         end
@@ -168,7 +168,7 @@ module ScaleRb
       # convert key to byte array
       def c(key)
         if key.start_with?('0x')
-          key.to_bytes
+          key._to_bytes
         elsif key.to_i.to_s == key # check if key is a number
           key.to_i
         else

data/lib/client/rpc_request_builder.rb

@@ -2,52 +2,54 @@
 
 require 'json'
 
-module RpcRequestBuilder
-  def build_json_rpc_body(method, params, id)
-    {
-      'id' => id,
-      'jsonrpc' => '2.0',
-      'method' => method,
-      'params' => params.reject(&:nil?)
-    }.to_json
-  end
+module ScaleRb
+  module RpcRequestBuilder
+    def build_json_rpc_body(method, params, id)
+      {
+        'id' => id,
+        'jsonrpc' => '2.0',
+        'method' => method,
+        'params' => params.reject(&:nil?)
+      }.to_json
+    end
 
-  def respond_to_missing?(*_args)
-    true
-  end
+    def respond_to_missing?(*_args)
+      true
+    end
 
-  # example:
-  #   state_getStorage(1, '0x363a..', 563_868)
-  #
-  #   ==
-  #
-  #   build_json_rpc_body('state_getStorage', ['0x363a..', 563_868], 1)
-  def method_missing(method, *args)
-    build_json_rpc_body(method, args[1..], args[0])
-  end
+    # example:
+    #   state_getStorage(1, '0x363a..', 563_868)
+    #
+    #   ==
+    #
+    #   build_json_rpc_body('state_getStorage', ['0x363a..', 563_868], 1)
+    def method_missing(method, *args)
+      build_json_rpc_body(method, args[1..], args[0])
+    end
 
-  ###################################
-  # derived functions
-  ###################################
-  def derived_state_get_storage(rpc_id, pallet_name, item_name, key = nil, registry = nil)
-    storage_key = StorageHelper.encode_storage_key(pallet_name, item_name, key, registry).to_hex
-    state_getStorage(rpc_id, [storage_key])
-  end
+    ###################################
+    # derived functions
+    ###################################
+    def derived_state_get_storage(rpc_id, pallet_name, item_name, key = nil, registry = nil)
+      storage_key = StorageHelper.encode_storage_key(pallet_name, item_name, key, registry)._to_hex
+      state_getStorage(rpc_id, [storage_key])
+    end
 
-  def derived_state_subscribe_storage(rpc_id, pallet_name, item_name, key = nil, registry = nil)
-    storage_key = StorageHelper.encode_storage_key(pallet_name, item_name, key, registry).to_hex
-    state_subscribeStorage(rpc_id, [storage_key])
-  end
+    def derived_state_subscribe_storage(rpc_id, pallet_name, item_name, key = nil, registry = nil)
+      storage_key = StorageHelper.encode_storage_key(pallet_name, item_name, key, registry)._to_hex
+      state_subscribeStorage(rpc_id, [storage_key])
+    end
 
-  def derived_eth_call(rpc_id, to, data, at = nil)
-    eth_call(
-      rpc_id,
-      [
-        {
-          'from' => nil, 'to' => to, 'data' => data
-        },
-        at
-      ]
-    )
+    def derived_eth_call(rpc_id, to, data, at = nil)
+      eth_call(
+        rpc_id,
+        [
+          {
+            'from' => nil, 'to' => to, 'data' => data
+          },
+          at
+        ]
+      )
+    end
   end
 end