scale.rb 0.2.4 → 0.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f8538580b5cc0d84add3684e3af10bbbba86bc741abb66bc5d38594c7de17894
-  data.tar.gz: a652f2dd8b436840f8b4e004fdf3fe81c699200fb68a11ea2ca52ae4a3e64062
+  metadata.gz: 5a2cf612b6cd7c832ee28aec4da8fcec7ebeac8dc393ba1af41b1aecd96aa484
+  data.tar.gz: 2035bde19211e78f604fcdd51a95cb3b653fc278024326787545655fa09b88da
 SHA512:
-  metadata.gz: a5a71617b20e22dc876b71414c6bdf78cfdc23b94444f010d902eb382bb8f26d92e06de9eedca805aca9ba408035a981a106fa1d944081a3426864d6351b6b58
-  data.tar.gz: 8a65c9e78531472b74f93eb48da5c0e54c7b05430342467afa03ead952643cc41901a4a8f6b908ba6e3e8721b9aa26e6e426d6664ffb8ab93390e7c0febfd74c
+  metadata.gz: b1e10fd308c6f38525a2150e2bba0da42966e3c67dd9ca5f299133fd16a1c59e4988fb33841b194b3437bdae71f3dbea43cd2e4102e39f24b0bb7de9fd54f6dd
+  data.tar.gz: fadad4fd7fd8ba14f02574bc594e2cc815b905fc75008f0735f38ba2381b87aff8ec7e2f5fa1b878e9d7658b88e34d861ccb8481fa82e5369c0bfb68af154d5a

data/.dockerignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.rakeTasks
+/.idea
+/target

data/Dockerfile

@@ -2,17 +2,20 @@ FROM ruby:2.6-alpine3.11
 
 ENV BUILD_PACKAGES curl-dev build-base
 
-RUN echo "http://mirrors.ustc.edu.cn/alpine/v3.11/main/" > /etc/apk/repositories && \
-    apk update && \
+RUN apk update && \
     apk upgrade && \
-    apk add git $BUILD_PACKAGES
+    apk add git curl $BUILD_PACKAGES
 
 WORKDIR /usr/src/app
 
 COPY . .
-RUN gem sources --add https://gems.ruby-china.com/ --remove https://rubygems.org/ && \
-    gem install bundler:1.17.3 && \
-    bundle config mirror.https://rubygems.org https://gems.ruby-china.com && \
+
+RUN curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y && \
+    source $HOME/.cargo/env && \
+    export RUSTFLAGS='-C target-feature=-crt-static' && \
+    make
+
+RUN gem install bundler:1.17.3 && \
     bundle install && \
     rake install:local
 

data/Gemfile.lock

@@ -1,32 +1,32 @@
 PATH
   remote: .
   specs:
-    scale.rb (0.2.4)
+    scale.rb (0.2.9)
       activesupport (>= 4.0.0)
       json (~> 2.3.0)
-      substrate_common.rb (~> 0.1.8)
+      substrate_common.rb (~> 0.1.9)
       thor (~> 0.19.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.2.2)
+    activesupport (6.0.3.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-      zeitwerk (~> 2.2)
+      zeitwerk (~> 2.2, >= 2.2.2)
     base58 (0.2.3)
     blake2b (0.10.0)
     coderay (1.1.2)
-    concurrent-ruby (1.1.6)
+    concurrent-ruby (1.1.7)
     diff-lcs (1.3)
     ffi (1.12.2)
-    i18n (1.8.2)
+    i18n (1.8.5)
       concurrent-ruby (~> 1.0)
-    json (2.3.0)
+    json (2.3.1)
     method_source (0.9.2)
-    minitest (5.14.0)
+    minitest (5.14.2)
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
@@ -44,7 +44,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.0)
-    substrate_common.rb (0.1.8)
+    substrate_common.rb (0.1.9)
       base58
       blake2b
       xxhash
@@ -53,7 +53,7 @@ GEM
     tzinfo (1.2.7)
       thread_safe (~> 0.1)
     xxhash (0.4.0)
-    zeitwerk (2.3.0)
+    zeitwerk (2.4.0)
 
 PLATFORMS
   ruby

data/README.md

@@ -10,7 +10,7 @@ This is a SCALE codec library implemented in ruby language for general use. It c
 
 This work is the prerequisite of our subsequent series of projects. We hope to familiarize and quickly access Polkadot and Substrate through ruby. We plan to develop the back end of our applications in ruby language, and then interact with nodes or synchronize data through this library.
 
-Please refer to the [official doc](https://substrate.dev/docs/en/overview/low-level-data-format) for more details about SCALE low-level data format.
+Please refer to the [official doc](https://substrate.dev/docs/en/knowledgebase/advanced/codec) for more details about SCALE low-level data format.
 
 Because the feature of ruby 2.6 is used, the ruby version is required to be >= 2.6. it will be compatible with older ruby versions when released.
 
@@ -79,10 +79,13 @@ examples in `exec/scale`
 rspec
 ```
 
-To run only low level format tests, call
+To run single test file:
 
-```
-rspec spec/low_level_spec.rb
+```bash
+rspec spec/types_spec.rb
+rspec spec/extrinsic_spec.rb
+rspec spec/metadata_spec.rb
+rspec spec/types_ffi_spec.rb
 ```
 
 
@@ -90,11 +93,11 @@ rspec spec/low_level_spec.rb
 
 1. update to latest image
 
-   `docker pull itering/scale`
+   `docker pull itering/scale:latest`
 
 2. Run image:
 
-   `docker run -it itering/scale`
+   `docker run -it itering/scale:latest`
 
    This  will enter the container with a linux shell opened. 
 

data/lib/metadata/metadata.rb

@@ -5,21 +5,8 @@ module Scale
       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', [
-                                      'MetadataV0',
-                                      'MetadataV1',
-                                      'MetadataV2',
-                                      'MetadataV3',
-                                      'MetadataV4',
-                                      'MetadataV5',
-                                      'MetadataV6',
-                                      'MetadataV7',
-                                      'MetadataV8',
-                                      'MetadataV9',
-                                      'MetadataV10',
-                                      'MetadataV11'
-                                    ]).decode(scale_bytes).value
+        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
           metadata = Metadata.new "Scale::Types::#{metadata_version}".constantize.decode(scale_bytes)
           metadata.version = metadata_version[9..].to_i
         else
@@ -30,6 +17,24 @@ module Scale
         end
         metadata
       end
+
+      def get_module(module_name)
+        modules = self.value.value[:metadata][:modules]
+        modules.each do |m|
+          if m[:name].downcase == module_name.downcase
+            return m
+          end
+        end
+      end
+
+      def get_module_call(module_name, call_name)
+        the_module = get_module(module_name)
+        the_module[:calls].each do |call|
+          if call[:name].downcase == call_name.downcase
+            return call
+          end
+        end
+      end
     end
 
     class MetadataModule
@@ -45,19 +50,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.type_of("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.type_of("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.type_of("Vec<MetadataModuleEvent>").decode(scale_bytes).value
           result[:events] = events.map(&:value)
         end
 
@@ -70,26 +75,26 @@ module Scale
       def self.decode(scale_bytes)
         result = {
           name: String.decode(scale_bytes).value,
-          modifier: Scale::Types.type_of('Enum', %w[Optional Default]).decode(scale_bytes).value
+          modifier: Scale::Types.type_of("Enum", %w[Optional Default]).decode(scale_bytes).value
         }
 
         is_key_value = Bool.decode(scale_bytes).value
         result[:type] = if is_key_value
                           {
                             Map: {
-                              key: adjust(String.decode(scale_bytes).value),
-                              value: adjust(String.decode(scale_bytes).value),
+                              key: String.decode(scale_bytes).value,
+                              value: String.decode(scale_bytes).value,
                               linked: Bool.decode(scale_bytes).value
                             }
                           }
                         else
                           {
-                            Plain: adjust(String.decode(scale_bytes).value)
+                            Plain: String.decode(scale_bytes).value
                           }
                         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.type_of("Vec<String>").decode(scale_bytes).value.map(&:value)
 
         MetadataModuleStorage.new(result)
       end
@@ -100,8 +105,8 @@ module Scale
       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.type_of("Vec<MetadataModuleCallArgument>").decode(scale_bytes).value.map(&:value)
+        result[:documentation] = Scale::Types.type_of("Vec<String>").decode(scale_bytes).value.map(&:value)
         MetadataModuleCall.new(result)
       end
     end
@@ -111,7 +116,7 @@ module Scale
       def self.decode(scale_bytes)
         result = {}
         result[:name] = String.decode(scale_bytes).value
-        result[:type] = adjust(String.decode(scale_bytes).value)
+        result[:type] = String.decode(scale_bytes).value
 
         MetadataModuleCallArgument.new(result)
       end
@@ -122,8 +127,8 @@ module Scale
       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.type_of("Vec<String>").decode(scale_bytes).value.map(&:value)
+        result[:documentation] = Scale::Types.type_of("Vec<String>").decode(scale_bytes).value.map(&:value)
 
         MetadataModuleEvent.new(result)
       end

data/lib/metadata/metadata_v0.rb

@@ -129,7 +129,7 @@ module Scale
       def self.decode(scale_bytes)
         id = U16.decode(scale_bytes).value
         name = Bytes.decode(scale_bytes).value
-        args = Scale::Types.type_of("Vec<MetadataModuleCallArgument>").decode(scale_bytes).value.map(&:value)
+        args = Scale::Types.type_of("Vec<MetadataV0ModuleCallArgument>").decode(scale_bytes).value.map(&:value)
         documentation = Scale::Types.type_of("Vec<Bytes>").decode(scale_bytes).value.map(&:value)
         MetadataV0ModuleFunction.new({
           id: id,
@@ -140,14 +140,14 @@ module Scale
       end
     end
 
-    class MetadataModuleCallArgument
+    class MetadataV0ModuleCallArgument
       include SingleValue
 
       def self.decode(scale_bytes)
         name = Bytes.decode(scale_bytes).value
         type = Bytes.decode(scale_bytes).value
 
-        MetadataModuleCallArgument.new({name: name, type: type})
+        MetadataV0ModuleCallArgument.new({name: name, type: type})
       end
     end
 

data/lib/metadata/metadata_v1.rb

@@ -92,26 +92,26 @@ module Scale
 
         if is_key_value
           type = {
-            MapType: {
-              key: adjust(Bytes.decode(scale_bytes).value),
-              value: adjust(Bytes.decode(scale_bytes).value)
+            Map: {
+              key: Bytes.decode(scale_bytes).value,
+              value: Bytes.decode(scale_bytes).value
             }
           }
         else
           type = {
-            PlainType: adjust(Bytes.decode(scale_bytes).value)
+            Plain: Bytes.decode(scale_bytes).value
           }
         end
 
         fallback = Hex.decode(scale_bytes).value
-        docs = Scale::Types.type_of("Vec<Bytes>").decode(scale_bytes).value
+        docs = Scale::Types.type_of("Vec<Bytes>").decode(scale_bytes).value.map(&:value)
 
         MetadataV1ModuleStorage.new({
           name: name,
           modifier: modifier,
           type: type,
-          default: fallback,
-          docs: docs
+          fallback: fallback,
+          documentation: docs
         })
       end
     end

data/lib/metadata/metadata_v12.rb

@@ -0,0 +1,87 @@
+module Scale
+  module Types
+    class MetadataV12
+      include SingleValue
+      attr_accessor :call_index, :event_index
+
+      def initialize(value)
+        @call_index = {}
+        @event_index = {}
+        super(value)
+      end
+
+      def self.decode(scale_bytes)
+        modules = Scale::Types.type_of("Vec<MetadataV12Module>").decode(scale_bytes).value
+
+        value = {
+          magicNumber: 1_635_018_093,
+          metadata: {
+            version: 12,
+            modules: modules.map(&:value)
+          }
+        }
+
+        result = MetadataV12.new(value)
+
+        call_module_index = 0
+        event_module_index = 0
+
+        modules.map(&:value).each do |m|
+          if m[:calls]
+            m[:calls].each_with_index do |call, index|
+              call[:lookup] = "%02x%02x" % [call_module_index, index]
+              result.call_index[call[:lookup]] = [m, call]
+            end
+            call_module_index += 1
+          end
+
+          if m[:events]
+            m[:events].each_with_index do |event, index|
+              event[:lookup] = "%02x%02x" % [event_module_index, index]
+              result.event_index[event[:lookup]] = [m, event]
+            end
+            event_module_index += 1
+          end
+        end
+
+        result
+      end
+    end
+
+    class MetadataV12Module
+      include SingleValue
+      def self.decode(scale_bytes)
+        name = String.decode(scale_bytes).value
+
+        result = {
+          name: name
+        }
+
+        has_storage = Bool.decode(scale_bytes).value
+        if has_storage
+          storage = MetadataV7ModuleStorage.decode(scale_bytes).value
+          result[:storage] = storage
+          result[:prefix] = storage[:prefix]
+        end
+
+        has_calls = Bool.decode(scale_bytes).value
+        if has_calls
+          calls = Scale::Types.type_of("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
+          result[:events] = events.map(&:value)
+        end
+
+        result[:constants] = Scale::Types.type_of("Vec<MetadataV7ModuleConstants>").decode(scale_bytes).value.map(&:value)
+        result[:errors] = Scale::Types.type_of("Vec<MetadataModuleError>").decode(scale_bytes).value.map(&:value)
+
+        result[:index] = U8.decode(scale_bytes).value
+        MetadataV12Module.new(result)
+      end
+    end
+  end
+end

data/lib/metadata/metadata_v4.rb

@@ -92,14 +92,14 @@ module Scale
         storage_function_type = Scale::Types.type_of("Enum", %w[Plain Map DoubleMap]).decode(scale_bytes).value
         if storage_function_type == "Plain"
           result[:type] = {
-            Plain: adjust(String.decode(scale_bytes).value)
+            Plain: String.decode(scale_bytes).value
           }
         elsif storage_function_type == "Map"
           result[:type] = {
             Map: {
               hasher: StorageHasher.decode(scale_bytes).value,
-              key: adjust(String.decode(scale_bytes).value),
-              value: adjust(String.decode(scale_bytes).value),
+              key: String.decode(scale_bytes).value,
+              value: String.decode(scale_bytes).value,
               linked: Bool.decode(scale_bytes).value
             }
           }
@@ -107,9 +107,9 @@ module Scale
           result[:type] = {
             DoubleMap: {
               hasher: StorageHasher.decode(scale_bytes).value,
-              key1: adjust(String.decode(scale_bytes).value),
-              key2: adjust(String.decode(scale_bytes).value),
-              value: adjust(String.decode(scale_bytes).value),
+              key1: String.decode(scale_bytes).value,
+              key2: String.decode(scale_bytes).value,
+              value: String.decode(scale_bytes).value,
               key2Hasher: StorageHasher.decode(scale_bytes).value
             }
           }