scale.rb 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 455155ae80fa2688bd42bf2dfdf5d0206e53ff8a645d2f8b0936bb7657fad3a9
-  data.tar.gz: 60c09397cb38825bfd9e67cfb52a770578e7b9d6b43d6e1db6acecc9af9dac78
+  metadata.gz: 1557cc1ad637937b0301af472bd99efae047d222dee854b4de014a3f4f58f5e9
+  data.tar.gz: 9d0cf93b3cd088ffb663332ff1de2b4cef0b5895c2eedb381a90de7e8be4b270
 SHA512:
-  metadata.gz: 2a71f2efdfbe7e376bc07c47ad35b9d1768f8b2c97c6047ae16b36ca583fbe75d23937f6e6342c624701bff2fa7f8b2a3118d9d9e5fd3db33571d9133e590713
-  data.tar.gz: 4c165871d267f740ec0f980a3fb88b5a56c0c83d3163b0268279597eec96c7e33a454ad29f9f1f5e4e0cd9e513425aabea148df7b0eee0e3a5191c358a935a90
+  metadata.gz: b2cb860a69f16ae7115474edd8f178f6b712a5ce5f146f21e8e30918b6b52d83f40380a60a84d576d832856c37f1813ec031750b45bebb1c3defa2e93de99677
+  data.tar.gz: c896365be27dcdf74590afe05e8543a80fa22f2585040f7fcf2ac185584368c26fae3f6ecc7b36a9a190624f5c2a1268f925634e405f52b34092a2b08e418260

data/.gitignore

@@ -8,3 +8,4 @@
 /tmp/
 /.rakeTasks
 /.idea
+/target

data/Cargo.lock

@@ -0,0 +1,44 @@
+# This file is automatically @generated by Cargo.
+# It is not intended for manual editing.
+[[package]]
+name = "SCALE-testing-interface"
+version = "0.1.0"
+dependencies = [
+ "parity-scale-codec",
+]
+
+[[package]]
+name = "arrayvec"
+version = "0.5.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "cff77d8686867eceff3105329d4698d96c2391c176d5d03adc90c7389162b5b8"
+
+[[package]]
+name = "bitvec"
+version = "0.15.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a993f74b4c99c1908d156b8d2e0fb6277736b0ecbd833982fd1241d39b2766a6"
+
+[[package]]
+name = "byte-slice-cast"
+version = "0.3.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b0a5e3906bcbf133e33c1d4d95afc664ad37fbdb9f6568d8043e7ea8c27d93d3"
+
+[[package]]
+name = "parity-scale-codec"
+version = "1.2.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f509c5e67ca0605ee17dcd3f91ef41cadd685c75a298fb6261b781a5acb3f910"
+dependencies = [
+ "arrayvec",
+ "bitvec",
+ "byte-slice-cast",
+ "serde",
+]
+
+[[package]]
+name = "serde"
+version = "1.0.104"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "414115f25f818d7dfccec8ee535d76949ae78584fc4f79a6f45a904bf8ab4449"

data/Cargo.toml

@@ -0,0 +1,11 @@
+[package]
+name = "SCALE-testing-interface"
+version = "0.1.0"
+authors = ["Robert Hambrock <robert@web3.foundation>"]
+
+[dependencies]
+parity-scale-codec = { version = "1.2.0" }
+
+[lib]
+name = "scale_ffi"
+crate-type = ["dylib"]

data/Dockerfile

@@ -13,6 +13,7 @@ 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 && \
-    bundle install
+    bundle install && \
+    rake install:local
 
 CMD ["sh"]

data/Gemfile

@@ -1,6 +1,6 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in scale.gemspec
 gemspec

data/Gemfile.lock

@@ -1,17 +1,32 @@
 PATH
   remote: .
   specs:
-    scale.rb (0.1.0)
-      substrate_common.rb (~> 0.1.3)
+    scale.rb (0.2.0)
+      activesupport (>= 4.0.0)
+      json (~> 2.3.0)
+      substrate_common.rb (~> 0.1.8)
+      thor (~> 0.20.3)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (6.0.2.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2)
     base58 (0.2.3)
     blake2b (0.10.0)
     coderay (1.1.2)
+    concurrent-ruby (1.1.6)
     diff-lcs (1.3)
+    ffi (1.12.2)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    json (2.3.0)
     method_source (0.9.2)
+    minitest (5.14.0)
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
@@ -29,17 +44,23 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.0)
-    substrate_common.rb (0.1.3)
+    substrate_common.rb (0.1.8)
       base58
       blake2b
       xxhash
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
     xxhash (0.4.0)
+    zeitwerk (2.3.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 1.17)
+  ffi (~> 1.12)
   pry
   rake (~> 13.0)
   rspec (~> 3.2)

data/Makefile

@@ -0,0 +1,13 @@
+ifeq ($(shell uname),Darwin)
+    EXT := dylib
+else
+    EXT := so
+endif
+
+all: target/debug/libscale_ffi.$(EXT)
+
+target/debug/libscale_ffi.$(EXT): src/lib.rs Cargo.toml
+	cargo build
+
+clean:
+	rm -rf target

data/README.md

@@ -2,11 +2,11 @@
 
 # scale.rb
 
-**Ruby SCALE Codec Library and Substrate Json-rpc Api Client.**
+**Ruby SCALE Codec Library**
 
 SCALE is a lightweight, efficient, binary serialization and deserialization codec used by substrate. Most of the input and output data of the substrate API are encoded in SCALE data format. 
 
-This is a SCALE codec library and substrate json-rpc api client implemented in ruby language for general use. It contains the implementation of low-level data formats, various substrate types, metadata support and json-rpc client.
+This is a SCALE codec library implemented in ruby language for general use. It contains the implementation of low-level data formats, various substrate types, metadata support.
 
 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.
 
@@ -53,40 +53,33 @@ p o.encode # "1501"
 ```
 Please go to `spec` dir for more examples.
 
-## Types supported
-
-scale.rb now support types:
-
-- [x] Compact
-- [x] Bool
-- [x] U8, U16, U32, U64, U128
-- [x] Enum
-- [x] Option
-- [x] Struct
-- [x] Tuple
-- [x] Vec
-- [x] Set
-- [x] Bytes
-- [x] Hex
-- [x] String
-- [x] H160, H256, H512
-- [x] AccountId
-- [x] Balance
-- [x] BalanceOf
-- [x] BlockNumber
-- [x] AccountIndex
-- [x] Era
+## Command line tools
+
+After install scale.rb gem, there is a command named `scale` available. You can use it directly in your terminal.
+
+```bash
+> scale
+Commands:
+  scale decode TYPE_NAME HEX SPEC_NAME SPEC_VERSION  # decode HEX string using TYPE_NAME
+  scale help [COMMAND]                               # Describe available commands or one specific command
+  scale specs                                        # list all chain specs
+  scale type TYPE_NAME SPEC_NAME SPEC_VERSION        # show type's ruby class
+  scale types SPEC_NAME SPEC_VERSION                 # list all types implemented for chain
+```
+
+examples in `exec/scale`
 
 ## Running tests
 
 1. Download or clone the code to local, and enter the code root directory
-2. Run all tests
+2. If rust is installed on your system (for instance, `curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh`), call `make` to build the FFI library
+3. Run all tests
 
 ```
 rspec
 ```
 
-2. Run low level format tests
+To run only low level format tests, call
 
 ```
 rspec spec/low_level_spec.rb
@@ -119,7 +112,7 @@ rspec spec/low_level_spec.rb
    19 examples, 0 failures
    ```
 
-4. Or type `./bin/console` to enter the ruby interactive environment and run any decode or encode code
+4. Or, type `./bin/console` to enter the ruby interactive environment and run any decode or encode code
 
    ```shell
    /usr/src/app # ./bin/console
@@ -133,6 +126,17 @@ rspec spec/low_level_spec.rb
    [4] pry(main)>
    ```
 
+5. Or, run command line tool:
+
+   ```shell
+   /usr/src/app # scale types kusama
+   HeadData => Scale::Types::HeadData
+   Conviction => Scale::Types::Conviction
+   EraRewards => Scale::Types::EraRewards
+   ...
+   
+   Count: 303
+   ```
 
 ## Development
 

data/Rakefile

@@ -1,2 +1,2 @@
-require "bundler/gem_tasks"
-task :default => :spec
+require 'bundler/gem_tasks'
+task default: :spec

data/bin/console

@@ -1,13 +1,13 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "scale"
+require 'bundler/setup'
+require 'scale'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
 
 # (If you use this, don't forget to add pry to your Gemfile!)
-require "pry"
+require 'pry'
 Pry.start
 
 # require "irb"

data/exe/scale

@@ -0,0 +1,80 @@
+#!/usr/bin/env ruby
+
+require 'scale'
+require 'thor'
+
+class ScaleCli < Thor
+  desc "specs", "list all chain specs"
+  def specs
+    path = File.join File.expand_path('../..', __FILE__), "lib", "type_registry", "*.json"
+    specs = Dir[path].map do |file|
+      File.basename file, ".json"
+    end
+    puts specs.join(", ")
+  end
+
+  # exmaples:
+  #   
+  #   scale types darwinia
+  #   =>
+  #   ProposalCategory => Scale::Types::ProposalCategory
+  #   VoteStage => Scale::Types::VoteStage
+  #   TallyType => Scale::Types::TallyType
+  #   ...
+  #
+  #   Count: 279
+  desc "types SPEC_NAME SPEC_VERSION", "list all types implemented for chain"
+  def types(spec_name = "default", spec_version = nil)
+    Scale::TypeRegistry.instance.load(spec_name, spec_version)
+    Scale::Types.list.each_pair do |type_name, type|
+      puts "#{green(type_name)} => #{yellow(type.to_s)}"
+    end
+
+    puts "\nCount: #{Scale::Types.list.length}"
+  end
+
+  # exmaples:
+  #
+  #   scale type Compact
+  #   => Scale::Types::Compact
+  #
+  #   scale type SessionKeysPolkadot kusama
+  #   => nil
+  #
+  #   scale type SessionKeysPolkadot kusama 1054
+  #   => Scale::Types::Struct_Of_AccountId_AccountId_AccountId_AccountId_AccountId_70247479160460
+  #
+  #   scale type "UnappliedSlash<AccountId, BalanceOf>"
+  #   => Scale::Types::Struct_Of_AccountId_AccountId_Vec˂UnappliedSlashOther˃_Vec˂AccountId˃_Balance_70145184872260
+  #
+  desc "type TYPE_NAME SPEC_NAME SPEC_VERSION", "show type's ruby class"
+  def type(type_name, spec_name = "default", spec_version = nil)
+    Scale::TypeRegistry.instance.load(spec_name, spec_version)
+    p Scale::Types.get(type_name)
+  end
+
+  # exmaples:
+  #
+  #   scale decode Compact 0x0300000040
+  #   => #<Scale::Types::Compact:0x00007fc86b9d1198 @value=1073741824>
+  desc "decode TYPE_NAME HEX SPEC_NAME SPEC_VERSION", "decode HEX string using TYPE_NAME"
+  def decode(type_name, hex, spec_name = "default", spec_version = nil)
+    Scale::TypeRegistry.instance.load(spec_name, spec_version)
+    type = Scale::Types.get(type_name)
+    scale_bytes = Scale::Bytes.new(hex)
+    p type.decode(scale_bytes)
+  end
+
+  # exmaples:
+  #
+  #   scale encode SessionIndex 2818
+  #   => #<Scale::Types::Compact:0x00007fc86b9d1198 @value=1073741824>
+  desc "encode TYPE_NAME VALUE SPEC_NAME SPEC_VERSION", "encode value"
+  def encode(type_name, value, spec_name = "default", spec_version = nil)
+    Scale::TypeRegistry.instance.load(spec_name, spec_version)
+    type = Scale::Types.get(type_name)
+    p "0x" + type.new(value.to_i).encode
+  end
+end
+
+ScaleCli.start(ARGV)

data/lib/metadata/metadata.rb

@@ -1,27 +1,34 @@
 module Scale
   module Types
-
     class Metadata
       include SingleValue
+      attr_accessor :version
       def self.decode(scale_bytes)
         bytes = scale_bytes.get_next_bytes(4)
         if bytes.bytes_to_utf8 == 'meta'
-          metadata_v_name = type_of("Enum", enum_values: [
-            "Scale::Types::MetadataV0", 
-            "Scale::Types::MetadataV1", 
-            "Scale::Types::MetadataV2", 
-            "Scale::Types::MetadataV3",
-            "Scale::Types::MetadataV4",
-            "Scale::Types::MetadataV5",
-            "Scale::Types::MetadataV6",
-            "Scale::Types::MetadataV7",
-            "Scale::Types::MetadataV8",
-            "Scale::Types::MetadataV9",
-            "Scale::Types::MetadataV10"
-          ]).decode(scale_bytes).value
-
-          Metadata.new(metadata_v_name.constantize.decode(scale_bytes).value)
+          metadata_version = Scale::Types.type_of('Enum', [
+                                      'MetadataV0',
+                                      'MetadataV1',
+                                      'MetadataV2',
+                                      'MetadataV3',
+                                      'MetadataV4',
+                                      'MetadataV5',
+                                      'MetadataV6',
+                                      'MetadataV7',
+                                      'MetadataV8',
+                                      'MetadataV9',
+                                      'MetadataV10',
+                                      'MetadataV11'
+                                    ]).decode(scale_bytes).value
+          metadata = Metadata.new "Scale::Types::#{metadata_version}".constantize.decode(scale_bytes)
+          metadata.version = metadata_version[9..].to_i
+        else
+          scale_bytes.reset_offset
+          metadata_v0 = Scale::Types::MetadataV0.decode(scale_bytes)
+          metadata = Metadata.new metadata_v0
+          metadata.version = 0
         end
+        metadata
       end
     end
 
@@ -38,19 +45,19 @@ module Scale
 
         has_storage = Bool.decode(scale_bytes).value
         if has_storage
-          storages = 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 = 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 = 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
 
@@ -61,29 +68,28 @@ module Scale
     class MetadataModuleStorage
       include SingleValue
       def self.decode(scale_bytes)
-
         result = {
           name: String.decode(scale_bytes).value,
-          modifier: type_of("Enum", enum_values: ["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
-        if is_key_value
-          result[:type] = {
-            Map: {
-              key: adjust(String.decode(scale_bytes).value),
-              value: adjust(String.decode(scale_bytes).value),
-              linked: Bool.decode(scale_bytes).value
-            }
-          }
-        else
-          result[:type] = {
-            Plain: adjust(String.decode(scale_bytes).value)
-          }
-        end
+        result[:type] = if is_key_value
+                          {
+                            Map: {
+                              key: adjust(String.decode(scale_bytes).value),
+                              value: adjust(String.decode(scale_bytes).value),
+                              linked: Bool.decode(scale_bytes).value
+                            }
+                          }
+                        else
+                          {
+                            Plain: adjust(String.decode(scale_bytes).value)
+                          }
+                        end
 
         result[:fallback] = Hex.decode(scale_bytes).value
-        result[:documentation] = 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
@@ -94,8 +100,8 @@ module Scale
       def self.decode(scale_bytes)
         result = {}
         result[:name] = String.decode(scale_bytes).value
-        result[:args] = type_of("Vec<MetadataModuleCallArgument>").decode(scale_bytes).value.map(&:value)
-        result[:documentation] = 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
@@ -116,12 +122,11 @@ module Scale
       def self.decode(scale_bytes)
         result = {}
         result[:name] = String.decode(scale_bytes).value
-        result[:args] = type_of("Vec<String>").decode(scale_bytes).value.map(&:value)
-        result[:documentation] = 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
     end
-
   end
 end