scale.rb 0.2.17 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b7ae809d469d6fb67c8fdf00ad6debf41b6c5f219d7cdf021f408d3368b7367
-  data.tar.gz: 19c3ea53bcc3bfaeff46735b135bdf985cc9d79830e90e75e9afa279c48d1af9
+  metadata.gz: 861596854598a5ea2a2648cc9fe3b32915eeba97a372f2c49ba1839537cd6741
+  data.tar.gz: 222a2e692373bd1523f37927a304c12f2d24d252c428be3b6beb8b4dc52163c8
 SHA512:
-  metadata.gz: 58f4cfe9d7430aff3c263be9e420d9779166f92ed42d9dd2e926238d8e5909073ed2241800123bb084ec513bc8fe1502f235392787d84dd81877ae61d2a54509
-  data.tar.gz: 27421c1d163fc130194cfd44249cca443f440bf37faca104ca5fc9db7884554d8f5d14bd4378ba583ffa4555be91fe99f4fa2430953824a109ed87f5ec18863b
+  metadata.gz: 68406b9ce9d33d5bf4513fc825f7e76b5e290f52a6b144893ff9df130e513ff01f20b647e51eab61efef2f15bb4b4be0db0b0a817cba465f268577199731f4d3
+  data.tar.gz: d0225db7a736a2909dd8e3967658b9fef543457e2eea479e09af8944161830fbad114782ec8fa0014e6a4df5f8599c3b128dcc16cc00c3518dcd836f1b6dd4ef

data/.gitignore

@@ -10,3 +10,4 @@
 /.idea
 /target
 .DS_Store
+/scripts/tmp.rb

data/Cargo.lock

@@ -1,5 +1,7 @@
 # This file is automatically @generated by Cargo.
 # It is not intended for manual editing.
+version = 3
+
 [[package]]
 name = "Inflector"
 version = "0.11.4"
@@ -15,6 +17,8 @@ name = "SCALE-testing-interface"
 version = "0.1.0"
 dependencies = [
  "frame-support",
+ "hex",
+ "libc",
  "parity-scale-codec",
  "sp-core",
 ]
@@ -642,9 +646,9 @@ dependencies = [
 
 [[package]]
 name = "hex"
-version = "0.4.2"
+version = "0.4.3"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "644f9158b2f133fd50f5fb3242878846d9eb792e445c893805ff0e3824006e35"
+checksum = "7f24254aa9a54b5c858eaee2f5bccdb46aaf0e486a595ed5fd8f86ba55232a70"
 
 [[package]]
 name = "hmac"
@@ -744,9 +748,9 @@ checksum = "e2abad23fbc42b3700f2f279844dc832adb2b2eb069b2df918f455c4e18cc646"
 
 [[package]]
 name = "libc"
-version = "0.2.82"
+version = "0.2.94"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "89203f3fba0a3795506acaad8ebce3c80c0af93f994d5a1d7a0b1eeb23271929"
+checksum = "18794a8ad5b29321f790b55d93dfba91e125cb1a9edbd4f8e3150acc771c1a5e"
 
 [[package]]
 name = "libsecp256k1"

data/Cargo.toml

@@ -8,11 +8,10 @@ edition = "2018"
 parity-scale-codec = { version = "1.3.6" }
 sp-core = { version = "2.0.0", git = "https://github.com/paritytech/substrate.git", features = ["full_crypto"]}
 frame-support = { version = "2.0.0", git = "https://github.com/paritytech/substrate.git" }
+libc = { version = "0.2.94" }
+hex = { version = "0.4.3" }
 
 [lib]
 name = "scale_ffi"
 crate-type = ["dylib"]
 
-[[bin]]
-name = "storage_key"
-path = "src/storage_key.rs"

data/Dockerfile

@@ -15,7 +15,10 @@ RUN curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y && \
     export RUSTFLAGS='-C target-feature=-crt-static' && \
     make
 
-RUN gem install bundler:1.17.3 && \
+ENV RUSTFLAGS='-C target-feature=-crt-static'
+ENV PATH=/root/.cargo/bin:$PATH
+
+RUN gem install bundler:2.2.13 && \
     bundle install && \
     rake install:local
 

data/Gemfile.lock

@@ -1,11 +1,12 @@
 PATH
   remote: .
   specs:
-    scale.rb (0.2.17)
+    scale.rb (0.3.1)
       base58
       blake2b_rs (~> 0.1.2)
       faye-websocket
       json (~> 2.3.0)
+      thor (~> 1.0)
       xxhash
 
 GEM
@@ -15,39 +16,40 @@ 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)
+    faye-websocket (0.11.1)
       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-driver (0.7.5)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
     xxhash (0.4.0)

data/README.md

@@ -1,5 +1,7 @@
 ![grants_badge](./grants_badge.png)
 
+**Warning: After v0.2.19, the develop branch will do a structure refactor and big optimization.**
+
 # scale.rb
 
 **Ruby SCALE Codec Library**
@@ -19,7 +21,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.19'
 ```
 
 And then execute:
@@ -37,10 +39,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 +62,37 @@ 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://rpc.darwinia.network"
+
+v = Scale::Types.get("EthereumTransactionIndex")
+  .new(
+    [
+      Scale::Types::H256.new("0x803054c2beacabc36e15c3147bb87d8320a02e9b601be28820a622dedd1c7717"),
+      Scale::Types::U64.new(266)
+    ]
+  )
+
+storage = client.get_storage("EthereumBacking", "VerifiedProof", [v])
+puts storage.to_human
+
+# get the raw data
+key = client.generate_storage_key("EthereumBacking", "VerifiedProof", [v])[0]
+storage_raw = client.state_getStorageAt(key)
+puts storage_raw
+
 ```
 Please go to `spec` dir for more examples.
 

data/Rakefile

@@ -1,2 +1,8 @@
 require 'bundler/gem_tasks'
+require "scale"
 task default: :spec
+
+desc 'Check types of a spec'
+task :check_types do
+  TypeRegistry.instance.load spec_name: 'darwinia'
+end

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/helper.rb

@@ -18,16 +18,30 @@ class SubstrateClient::Helper
         return_type = map[:value]
         # TODO: decode to account id if param is address
         # params[0] = decode(params[0]) if map[:key] == "AccountId"
+
         type = Scale::Types.get(map[:key])
-        params[0] = type.new(params[0]).encode
+        if params[0].class != type
+          raise Scale::StorageInputTypeError.new("The type of first param is not equal to the type from metadata: #{map[:key]} => #{type}")
+        end
+        params[0] = params[0].encode
       elsif map = storage_item[:type][:DoubleMap]
         raise "Storage call of type \"DoubleMapType\" requires 2 parameters" if params.nil? || params.length != 2
 
         hasher = map[:hasher]
         hasher2 = map[:key2Hasher]
         return_type = map[:value]
-        params[0] = Scale::Types.get(map[:key1]).new(params[0]).encode
-        params[1] = Scale::Types.get(map[:key2]).new(params[1]).encode
+
+        type1 = Scale::Types.get(map[:key1])
+        if params[0].class != type1
+          raise Scale::StorageInputTypeError.new("The type of 1st param is not equal to the type from metadata: #{map[:key1]} => #{type1.class.name}")
+        end
+        params[0] = params[0].encode
+
+        type2 = Scale::Types.get(map[:key2])
+        if params[1].class != type2
+          raise Scale::StorageInputTypeError.new("The type of 2nd param is not equal to the type from metadata: #{map[:key2]} => #{type2.class.name}")
+        end
+        params[1] = params[1].encode
       else
         raise NotImplementedError
       end
@@ -41,7 +55,8 @@ class SubstrateClient::Helper
         hasher2,
         metadata.value.value[:metadata][:version]
       )
-      [storage_key, return_type]
+      storage_modifier = storage_item[:modifier]
+      [storage_key, return_type, storage_item]
     end
 
     def generate_storage_key(module_name, storage_name, params = nil, hasher = nil, hasher2 = nil, metadata_version = nil)

data/lib/metadata/metadata.rb

@@ -1,12 +1,16 @@
 module Scale
   module Types
     class Metadata
-      include SingleValue
+      include Base
       attr_accessor :version
       def self.decode(scale_bytes)
         bytes = scale_bytes.get_next_bytes(4)
         if bytes.bytes_to_utf8 == "meta"
-          metadata_version = Scale::Types.type_of("Enum", %w[MetadataV0 MetadataV1 MetadataV2 MetadataV3 MetadataV4 MetadataV5 MetadataV6 MetadataV7 MetadataV8 MetadataV9 MetadataV10 MetadataV11 MetadataV12]).decode(scale_bytes).value
+          version_enum = {
+            "type" => "enum",
+            "value_list" => %w[MetadataV0 MetadataV1 MetadataV2 MetadataV3 MetadataV4 MetadataV5 MetadataV6 MetadataV7 MetadataV8 MetadataV9 MetadataV10 MetadataV11 MetadataV12 MetadataV13]
+          }
+          metadata_version = Scale::Types.get(version_enum).decode(scale_bytes).value
           metadata = Metadata.new "Scale::Types::#{metadata_version}".constantize2.decode(scale_bytes)
           metadata.version = metadata_version[9..].to_i
         else
@@ -48,7 +52,7 @@ module Scale
     end
 
     class MetadataModule
-      include SingleValue
+      include Base
       def self.decode(scale_bytes)
         name = String.decode(scale_bytes).value
         prefix = String.decode(scale_bytes).value
@@ -60,19 +64,19 @@ module Scale
 
         has_storage = Bool.decode(scale_bytes).value
         if has_storage
-          storages = Scale::Types.type_of("Vec<MetadataModuleStorage>").decode(scale_bytes).value
+          storages = Scale::Types.get("Vec<MetadataModuleStorage>").decode(scale_bytes).value
           result[:storage] = storages.map(&:value)
         end
 
         has_calls = Bool.decode(scale_bytes).value
         if has_calls
-          calls = Scale::Types.type_of("Vec<MetadataModuleCall>").decode(scale_bytes).value
+          calls = Scale::Types.get("Vec<MetadataModuleCall>").decode(scale_bytes).value
           result[:calls] = calls.map(&:value)
         end
 
         has_events = Bool.decode(scale_bytes).value
         if has_events
-          events = Scale::Types.type_of("Vec<MetadataModuleEvent>").decode(scale_bytes).value
+          events = Scale::Types.get("Vec<MetadataModuleEvent>").decode(scale_bytes).value
           result[:events] = events.map(&:value)
         end
 
@@ -85,11 +89,17 @@ module Scale
     end
 
     class MetadataModuleStorage
-      include SingleValue
+      include Base
       def self.decode(scale_bytes)
+        name = String.decode(scale_bytes).value
+        enum = {
+          "type" => "enum",
+          "value_list" => ["Optional", "Default"]
+        }
+        modifier = Scale::Types.get(enum).decode(scale_bytes).value
         result = {
-          name: String.decode(scale_bytes).value,
-          modifier: Scale::Types.type_of("Enum", %w[Optional Default]).decode(scale_bytes).value
+          name: name,
+          modifier: modifier
         }
 
         is_key_value = Bool.decode(scale_bytes).value
@@ -108,25 +118,25 @@ module Scale
                         end
 
         result[:fallback] = Hex.decode(scale_bytes).value
-        result[:documentation] = Scale::Types.type_of("Vec<String>").decode(scale_bytes).value.map(&:value)
+        result[:documentation] = Scale::Types.get("Vec<String>").decode(scale_bytes).value.map(&:value)
 
         MetadataModuleStorage.new(result)
       end
     end
 
     class MetadataModuleCall
-      include SingleValue
+      include Base
       def self.decode(scale_bytes)
         result = {}
         result[:name] = String.decode(scale_bytes).value
-        result[:args] = Scale::Types.type_of("Vec<MetadataModuleCallArgument>").decode(scale_bytes).value.map(&:value)
-        result[:documentation] = Scale::Types.type_of("Vec<String>").decode(scale_bytes).value.map(&:value)
+        result[:args] = Scale::Types.get("Vec<MetadataModuleCallArgument>").decode(scale_bytes).value.map(&:value)
+        result[:documentation] = Scale::Types.get("Vec<String>").decode(scale_bytes).value.map(&:value)
         MetadataModuleCall.new(result)
       end
     end
 
     class MetadataModuleCallArgument
-      include SingleValue
+      include Base
       def self.decode(scale_bytes)
         result = {}
         result[:name] = String.decode(scale_bytes).value
@@ -137,12 +147,12 @@ module Scale
     end
 
     class MetadataModuleEvent
-      include SingleValue
+      include Base
       def self.decode(scale_bytes)
         result = {}
         result[:name] = String.decode(scale_bytes).value
-        result[:args] = Scale::Types.type_of("Vec<String>").decode(scale_bytes).value.map(&:value)
-        result[:documentation] = Scale::Types.type_of("Vec<String>").decode(scale_bytes).value.map(&:value)
+        result[:args] = Scale::Types.get("Vec<String>").decode(scale_bytes).value.map(&:value)
+        result[:documentation] = Scale::Types.get("Vec<String>").decode(scale_bytes).value.map(&:value)
 
         MetadataModuleEvent.new(result)
       end