scale.rb 0.2.17 → 0.2.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b7ae809d469d6fb67c8fdf00ad6debf41b6c5f219d7cdf021f408d3368b7367
-  data.tar.gz: 19c3ea53bcc3bfaeff46735b135bdf985cc9d79830e90e75e9afa279c48d1af9
+  metadata.gz: 6c509663910bc3e5dd790fd40e4e0d04ac4f589c44a0253b8b1b353b17687d82
+  data.tar.gz: 30249e26671d18d7568c58df2926a5aa071a4ca7b25af443315c8a92a65d292f
 SHA512:
-  metadata.gz: 58f4cfe9d7430aff3c263be9e420d9779166f92ed42d9dd2e926238d8e5909073ed2241800123bb084ec513bc8fe1502f235392787d84dd81877ae61d2a54509
-  data.tar.gz: 27421c1d163fc130194cfd44249cca443f440bf37faca104ca5fc9db7884554d8f5d14bd4378ba583ffa4555be91fe99f4fa2430953824a109ed87f5ec18863b
+  metadata.gz: 4ce9f292eeca2be4bc9f2967f9806730bedfd2fc14b4837a6d3cbea2808f62fbadffd31a40e218968ad2bac886338359bb01c164ed9a781186d78f54dbfb7293
+  data.tar.gz: 590a67087cdd8fe40717a0ec255bf0c824e807eec1f5f476c856b5002280f7680f0534559648e3ec3470a66194fd9fa141a1b1a277bbebc8dea15cc838027c5c

data/Gemfile.lock

@@ -1,11 +1,12 @@
 PATH
   remote: .
   specs:
-    scale.rb (0.2.17)
+    scale.rb (0.2.18)
       base58
       blake2b_rs (~> 0.1.2)
       faye-websocket
       json (~> 2.3.0)
+      thor (~> 1.0)
       xxhash
 
 GEM
@@ -15,37 +16,38 @@ GEM
     blake2b_rs (0.1.2)
       ffi (= 1.15.0)
       thermite (~> 0)
-    coderay (1.1.2)
-    diff-lcs (1.3)
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
     eventmachine (1.2.7)
     faye-websocket (0.11.0)
       eventmachine (>= 0.12.0)
       websocket-driver (>= 0.5.1)
     ffi (1.15.0)
     json (2.3.1)
-    method_source (0.9.2)
+    method_source (1.0.0)
     minitar (0.9)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    rake (13.0.1)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.0)
-      rspec-support (~> 3.9.0)
-    rspec-expectations (3.9.0)
+    pry (0.14.0)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (13.0.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
     thermite (0.13.0)
       minitar (~> 0.5)
       rake (>= 10)
       tomlrb (~> 1.2)
+    thor (1.1.0)
     tomlrb (1.3.0)
     websocket-driver (0.7.3)
       websocket-extensions (>= 0.1.0)

data/README.md

@@ -19,7 +19,7 @@ Because the feature of ruby 2.6 is used, the ruby version is required to be >= 2
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'scale.rb', '0.2.16'
+gem 'scale.rb', '0.2.18'
 ```
 
 And then execute:
@@ -37,10 +37,22 @@ Or install it yourself as:
 ```ruby
 require "scale"
 
+Scale::TypeRegistry.instance.load # default
+# Scale::TypeRegistry.instance.load spec_name: "pangolin"
+# Scale::TypeRegistry.instance.load spec_name: "kusama"
+
+# print hex changes if you set debug to true, default is false
+Scale::Types.debug = true
+
 # decode a compact integer
 scale_bytes = Scale::Bytes.new("0x1501") # create scale_bytes object from scale encoded hex string
 o = Scale::Types::Compact.decode(scale_bytes) # use scale type to decode scale_bytes object
 p o.value # 69
+
+#
+type = Scale::Types::get("Vec<U8>")
+o = type.decode(Scale::Bytes.new("0x080001"))
+assert_eq o.value, [Scale::Types::U8.new(0), Scale::Types::U8.new(1)]
 ```
 
 2. encode
@@ -48,8 +60,23 @@ p o.value # 69
 ```ruby
 require "scale"
 
+Scale::TypeRegistry.instance.load
+
 o = Scale::Types::Compact.new(69)
 p o.encode # "1501"
+
+type = Scale::Types::get("Vec<U8>")
+o = type.new([Scale::Types::U8.new(0), Scale::Types::U8.new(1)])
+p o.encode # "080001"
+```
+
+3. client
+```ruby
+require "scale"
+
+client = SubstrateClient.new "wss://pangolin-rpc.darwinia.network"
+client.get_storage("EthereumRelay", "ConfirmedHeaderParcels", [0])
+
 ```
 Please go to `spec` dir for more examples.
 

data/exe/scale

@@ -0,0 +1,49 @@
+#!/usr/bin/env ruby
+
+require "thor"
+require "scale"
+
+class ScaleCli < Thor
+  desc "list-types WS_ENDPOINT ", "list all types in metadata"
+  def list_types(ws)
+    client = SubstrateClient.new ws
+    metadata = client.get_metadata.value.to_human.to_json
+    metadata = JSON.parse(metadata)
+
+    types = []
+    metadata["metadata"]["modules"].each do |m|
+      if m["storage"]
+        m["storage"]["items"].each do |storage|
+          type = storage["type"]
+          if type["Plain"]
+            types << type["Plain"].gsub("\n ", "").gsub("\n", "")
+          elsif type["Map"]
+            types << type["Map"]["key"].gsub("\n", "")
+            types << type["Map"]["value"].gsub("\n", "")
+          end
+        end
+      end
+
+      if m["calls"]
+        m["calls"].each do |call|
+          call["args"].each do |arg|
+            types << arg["type"].gsub("\n", "")
+          end
+        end
+      end
+
+      if m["events"]
+        m["events"].each do |event|
+          event["args"].each do |arg|
+            types << arg.gsub("\n", "")
+          end
+        end
+      end
+    end
+
+    types.uniq!
+    puts types
+  end
+end
+
+ScaleCli.start(ARGV)

data/lib/scale.rb

@@ -242,12 +242,18 @@ module Scale
   end
 
   module Types
+    class << self
+      attr_accessor :debug
+    end
+    
     def self.list
       TypeRegistry.instance.types
     end
 
     def self.get(type_name)
-      TypeRegistry.instance.get(type_name)
+      type = TypeRegistry.instance.get(type_name)
+      raise "Type '#{type_name}' not exist" if type.nil?
+      type
     end
 
     def self.constantize(type)
@@ -272,13 +278,32 @@ module Scale
         type_str = type_strs.first
         inner_type_str = type_strs.last
 
-        if type_str == "Vec" || type_str == "Option"
-          klass = Class.new do
-            include Scale::Types.type_of(type_str)
-            inner_type inner_type_str
+        if type_str == "Vec"
+          name = "#{type_str}<#{inner_type_str.camelize2}>"
+          name = fix(name)
+
+          if !Scale::Types.const_defined?(name)
+            klass = Class.new do
+              include Scale::Types::Vec
+              inner_type inner_type_str
+            end
+            Scale::Types.const_set name, klass
+          else
+            Scale::Types.const_get name
+          end
+        elsif type_str == "Option"
+          name = "#{type_str}<#{inner_type_str.camelize2}>"
+          name = fix(name)
+
+          if !Scale::Types.const_defined?(name)
+            klass = Class.new do
+              include Scale::Types::Option
+              inner_type inner_type_str
+            end
+            Scale::Types.const_set name, klass
+          else
+            Scale::Types.const_get name
           end
-          name = "#{type_str}<#{inner_type_str.camelize2}>_#{klass.object_id}"
-          Scale::Types.const_set fix(name), klass
         else
           raise "#{type_str} not support inner type: #{type_string}"
         end
@@ -295,12 +320,17 @@ module Scale
           type_str.strip.tr(";", ",")
         end
 
-        klass = Class.new do
-          include Scale::Types::Tuple
-          inner_types *type_strs
+        name = "TupleOf#{type_strs.map(&:camelize2).join("")}"
+        name = fix(name)
+        if !Scale::Types.const_defined?(name)
+          klass = Class.new do
+            include Scale::Types::Tuple
+            inner_types *type_strs
+          end
+          Scale::Types.const_set name, klass
+        else
+          Scale::Types.const_get name
         end
-        name = "Tuple_Of_#{type_strs.map(&:camelize2).join("_")}_#{klass.object_id}"
-        Scale::Types.const_set fix(name), klass
       else
         if type_string == "Enum"
           # TODO: combine values to items
@@ -343,12 +373,20 @@ module Scale
 
 end
 
+# def fix(name)
+#   name
+#     .gsub("<", "˂").gsub(">", "˃")
+#     .gsub("(", "⁽").gsub(")", "⁾")
+#     .gsub(" ", "").gsub(",", "‚")
+#     .gsub(":", "։")
+# end
+
 def fix(name)
   name
-    .gsub("<", "˂").gsub(">", "˃")
-    .gsub("(", "⁽").gsub(")", "⁾")
-    .gsub(" ", "").gsub(",", "‚")
-    .gsub(":", "։")
+    .gsub("<", "").gsub(">", "")
+    .gsub("(", "").gsub(")", "")
+    .gsub(" ", "").gsub(",", "")
+    .gsub(":", "")
 end
 
 def rename(type)
@@ -426,3 +464,5 @@ class ::Hash
     Hash[h]
   end
 end
+
+Scale::Types.debug = false

data/lib/scale/base.rb

@@ -33,6 +33,17 @@ module Scale
           @value
         end
       end
+
+      module ClassMethods
+        def inherited(child)
+          child.const_set(:TYPE_NAME, child.name)
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+        base.const_set(:TYPE_NAME, base.name)
+      end
     end
 
     # value: one of nil, false, true, scale object
@@ -41,19 +52,24 @@ module Scale
 
       module ClassMethods
         def decode(scale_bytes)
+          puts "BEGIN " + self::TYPE_NAME + ": #{scale_bytes}" if Scale::Types.debug == true
           byte = scale_bytes.get_next_bytes(1)
           if byte == [0]
+            puts "  END " + self::TYPE_NAME + ": #{scale_bytes}" if Scale::Types.debug == true
             new(nil)
           elsif byte == [1]
             if self::INNER_TYPE_STR == "boolean"
+              puts "  END " + self::TYPE_NAME + ": #{scale_bytes}" if Scale::Types.debug == true
               new(false)
             else
               # big process
               value = Scale::Types.get(self::INNER_TYPE_STR).decode(scale_bytes)
+              puts "  END " + self::TYPE_NAME + ": #{scale_bytes}" if Scale::Types.debug == true
               new(value)
             end
           elsif byte == [2]
             if self::INNER_TYPE_STR == "boolean"
+              puts "  END " + self::TYPE_NAME + ": #{scale_bytes}" if Scale::Types.debug == true
               new(true)
             else
               raise "bad data"
@@ -89,9 +105,11 @@ module Scale
 
       module ClassMethods
         def decode(scale_bytes)
+          puts "BEGIN " + self::TYPE_NAME + ": #{scale_bytes}" if Scale::Types.debug == true
           bytes = scale_bytes.get_next_bytes self::BYTE_LENGTH
           bit_length = bytes.length.to_i * 8
           value = bytes.reverse.bytes_to_hex.to_i(16).to_signed(bit_length)
+          puts "  END " + self::TYPE_NAME + ": #{scale_bytes}" if Scale::Types.debug == true
           new(value)
         end
       end
@@ -117,10 +135,15 @@ module Scale
         attr_accessor :byte_length
 
         def decode(scale_bytes)
+          puts "BEGIN " + self::TYPE_NAME + ": #{scale_bytes}" if Scale::Types.debug == true
           bytes = scale_bytes.get_next_bytes self::BYTE_LENGTH
           bytes_reversed = bytes.reverse
           hex = bytes_reversed.reduce("0x") { |hex, byte| hex + byte.to_s(16).rjust(2, "0") }
-          new(hex.to_i(16))
+          result = new(hex.to_i(16))
+
+          puts "  END " + self::TYPE_NAME + ": #{scale_bytes}" if Scale::Types.debug == true
+
+          result
         end
       end
 
@@ -142,9 +165,14 @@ module Scale
       include SingleValue
       # new(1.to_u32, U32(69))
       module ClassMethods
+        def inherited(child)
+          child.const_set(:TYPE_NAME, child.name)
+        end
+
         def decode(scale_bytes)
+          puts "BEGIN " + self::TYPE_NAME + ": #{scale_bytes}" if Scale::Types.debug == true
           item_values = self::ITEM_TYPE_STRS.map do |item_type_str|
-            type = Scale::TypeRegistry.instance.get(item_type_str)
+            type = Scale::Types.get(item_type_str)
             type.decode(scale_bytes)
           end
 
@@ -157,6 +185,7 @@ module Scale
           value.each_pair do |attr, val|
             result.send "#{attr}=", val
           end
+          puts "  END " + self::TYPE_NAME + ": #{scale_bytes}" if Scale::Types.debug == true
           result
         end
 
@@ -177,6 +206,7 @@ module Scale
 
       def self.included(base)
         base.extend ClassMethods
+        base.const_set(:TYPE_NAME, base.name)
       end
 
       def encode
@@ -193,9 +223,11 @@ module Scale
 
       module ClassMethods
         def decode(scale_bytes)
+          puts "BEGIN " + self::TYPE_NAME + ": #{scale_bytes}" if Scale::Types.debug == true
           values = self::TYPE_STRS.map do |type_str|
             Scale::Types.get(type_str).decode(scale_bytes)
           end
+          puts "  END " + self::TYPE_NAME + ": #{scale_bytes}" if Scale::Types.debug == true
           new(values)
         end
 
@@ -218,6 +250,7 @@ module Scale
 
       module ClassMethods
         def decode(scale_bytes)
+          puts "BEGIN " + self::TYPE_NAME + ": #{scale_bytes}" if Scale::Types.debug == true
           index = scale_bytes.get_next_bytes(1)[0]
           if const_defined? "ITEM_TYPE_STRS"
             item_type_str = self::ITEM_TYPE_STRS[index]
@@ -226,7 +259,9 @@ module Scale
           else
             value = self::VALUES[index]
           end
-          new(value)
+          result = new(value)
+          puts "  END " + self::TYPE_NAME + ": #{scale_bytes}" if Scale::Types.debug == true
+          result
         end
 
         def items(items)
@@ -279,6 +314,7 @@ module Scale
 
       module ClassMethods
         def decode(scale_bytes, raw = false)
+          puts "BEGIN " + self::TYPE_NAME + ": #{scale_bytes}" if Scale::Types.debug == true
           number = Scale::Types::Compact.decode(scale_bytes).value
           items = []
           number.times do
@@ -286,6 +322,7 @@ module Scale
             item = type.decode(scale_bytes)
             items << item
           end
+          puts "  END " + self::TYPE_NAME + ": #{scale_bytes}" if Scale::Types.debug == true
           raw ? items : new(items)
         end
 
@@ -313,10 +350,12 @@ module Scale
 
       module ClassMethods
         def decode(scale_bytes)
+          puts "  BEGIN " + self::TYPE_NAME + ": #{scale_bytes}" if Scale::Types.debug == true
           value = "Scale::Types::U#{self::BYTE_LENGTH * 8}".constantize2.decode(scale_bytes).value
           return new [] unless value || value <= 0
 
           result = self::ITEMS.select { |_, mask| value & mask > 0 }.keys
+          puts "  END " + self::TYPE_NAME + ": #{scale_bytes}" if Scale::Types.debug == true
           new result
         end
 
@@ -349,14 +388,17 @@ module Scale
 
       module ClassMethods
         def decode(scale_bytes)
+          puts "  BEGIN " + self::TYPE_NAME + ": #{scale_bytes}" if Scale::Types.debug == true
           byte_length = self::BYTE_LENGTH
           raise "#{self.name} byte length is wrong: #{byte_length}" unless %w[2 3 4 8 16 20 32 64 128 256].include?(byte_length.to_s)
 
           bytes = scale_bytes.get_next_bytes(byte_length)
           str = bytes.pack("C*").force_encoding("utf-8")
           if str.valid_encoding?
+            puts "  END " + self::TYPE_NAME + ": #{scale_bytes}" if Scale::Types.debug == true
             new str
           else
+            puts "  END " + self::TYPE_NAME + ": #{scale_bytes}" if Scale::Types.debug == true
             new bytes.bytes_to_hex
           end
         end