scale.rb 0.2.16 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '06486e89da3732a84ca4f980e8b01e135521e51b4a26b0d67d5684e9abc5ad85'
-  data.tar.gz: b23b2ba8bd7ca6b9746caa8019f73710a6c2cd4613576fb6d0ac4da433aeb0ea
+  metadata.gz: 2ce5a456e8313b36d61cbfbff272c86985a6dc240603b37d6e96bd1cc0f28a9b
+  data.tar.gz: fda311dc30d0f8b31c62d9332bf241bab5b5646b6919fcb3b41814126692f469
 SHA512:
-  metadata.gz: 9407464fea76e85c960219fd19eea5db480f207db7b6f24a96ddfb819c06ce822c1b3649c1a3064e2be697bb3305b0328e0dbb9d04fc8f69851673b3b6a54bbe
-  data.tar.gz: 6c54d51a1af71fc24504eb77a1182248923386629ebc1e0a86002d8a3b299ef1deea19c388561430c4e7cb4102b3e7669726d5ec6fa9479f6a04c82feeac7863
+  metadata.gz: 2d9d0c5ccc5cdc2e34515af88a64164678ce6f18a128f3e935906a362979ff6be7e83c0ea9ab17350acb3fb91e67766dbc3bc247fc733dd4310c9efb3aaf6857
+  data.tar.gz: 9c0a9f424308e368dc886ad31f568b118fa5596d21b7d5cd9d79bbefcf41a8324c4d3f885f24334165cac769e33da988f2b1f03097a966f19003b7c027cd8ab3

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,47 +1,55 @@
 PATH
   remote: .
   specs:
-    scale.rb (0.2.16)
+    scale.rb (0.3.0)
+      base58
+      blake2b_rs (~> 0.1.2)
+      faye-websocket
       json (~> 2.3.0)
-      kontena-websocket-client (~> 0.1.1)
-      substrate_common.rb (~> 0.1.10)
-      thor (~> 0.19.0)
+      thor (~> 1.0)
+      xxhash
 
 GEM
   remote: https://rubygems.org/
   specs:
     base58 (0.2.3)
-    blake2b (0.10.0)
-    coderay (1.1.2)
-    diff-lcs (1.3)
-    ffi (1.12.2)
+    blake2b_rs (0.1.2)
+      ffi (= 1.15.0)
+      thermite (~> 0)
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    eventmachine (1.2.7)
+    faye-websocket (0.11.1)
+      eventmachine (>= 0.12.0)
+      websocket-driver (>= 0.5.1)
+    ffi (1.15.0)
     json (2.3.1)
-    kontena-websocket-client (0.1.1)
-      websocket-driver (~> 0.6.5)
-    method_source (0.9.2)
-    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)
+    method_source (1.0.0)
+    minitar (0.9)
+    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)
-    substrate_common.rb (0.1.10)
-      base58
-      blake2b
-      xxhash
-    thor (0.19.4)
-    websocket-driver (0.6.5)
+      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.5)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
     xxhash (0.4.0)
@@ -50,12 +58,12 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.17)
-  ffi (~> 1.12)
+  bundler
+  ffi (~> 1.15.0)
   pry
   rake (~> 13.0)
   rspec (~> 3.2)
   scale.rb!
 
 BUNDLED WITH
-   1.17.3
+   2.2.13

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'
+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

@@ -1,88 +1,48 @@
 #!/usr/bin/env ruby
 
-require 'scale'
-require 'thor'
+require "thor"
+require "scale"
 
 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"
+  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
-    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
 
-  desc "check_read_proof ROOT PROOF STORAGE_KEY", "check read proof and output leaf's value"
-  def check_read_proof(root, proof, storage_key)
-    Scale::TypeRegistry.instance.load
-    proof = proof.split(",").map(&:strip)
-    
-    value = Scale::Types::TrieNode::check(root, proof, storage_key)
-    p value
+    types.uniq!
+    puts types
   end
 end
 

data/lib/address.rb

@@ -0,0 +1,3 @@
+require 'blake2b'
+require 'base58'
+

data/lib/common.rb

@@ -0,0 +1,163 @@
+require 'xxhash'
+require 'blake2b'
+require 'base58'
+
+class Array
+  def bytes_to_hex
+    raise "Not a byte array" unless self.is_byte_array?
+    '0x' + self.map { |b| b.to_s(16).rjust(2, '0') }.join
+  end
+
+  def bytes_to_bin
+    raise "Not a byte array" unless self.is_byte_array?
+    '0b' + self.map { |b| b.to_s(2).rjust(8, '0') }.join
+  end
+
+  def bytes_to_bin
+    raise "Not a byte array" unless self.is_byte_array?
+    self.map { |b| b.to_s(2).rjust(8, '0') }
+  end
+
+  def bytes_to_utf8
+    raise "Not a byte array" unless self.is_byte_array?
+    self.pack('C*').force_encoding('utf-8')
+  end
+
+  def is_byte_array?
+    self.all? {|e| e >= 0 and e <= 255 }
+  end
+end
+
+class String
+  def constantize2
+    Object.const_get(self)
+  end
+
+  def hex_to_bytes
+    data = self.start_with?('0x') ? self[2..] : self
+    raise "Not valid hex string" if data.length % 2 != 0
+    data.scan(/../).map(&:hex)
+  end
+end
+
+module Crypto
+  def self.identity(bytes)
+    bytes.bytes_to_hex[2..]
+  end
+
+  def self.twox64(data)
+    result = XXhash.xxh64 data, 0
+    bytes = result.to_s(16).rjust(16, '0').hex_to_bytes.reverse
+    bytes.bytes_to_hex[2..]
+  end
+
+  def self.twox128(data)
+    bytes = []
+    2.times do |i|
+      result = XXhash.xxh64 data, i
+      bytes = bytes + result.to_s(16).rjust(16, '0').hex_to_bytes.reverse
+    end
+    bytes.bytes_to_hex[2..]
+  end
+
+  def self.twox64_concat(bytes)
+    data = bytes.bytes_to_utf8
+    twox64(data) + bytes.bytes_to_hex[2..]
+  end
+
+  def self.blake2_128(bytes)
+    Blake2b.hex bytes, 16
+  end
+
+  def self.blake2_256(bytes)
+    Blake2b.hex bytes, 32
+  end
+
+  def self.blake2_128_concat(bytes)
+    blake2_128(bytes) + bytes.bytes_to_hex[2..]
+  end
+end
+
+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].unpack("C*").first
+
+      raise "Invalid address type" unless TYPES.include?(addr_type)
+      
+      hash_bytes = make_hash(decoded[0, size])
+      if is_pubkey
+        is_valid_checksum = decoded[-2].unpack("C*").first == hash_bytes[0] && decoded[-1].unpack("C*").first == hash_bytes[1]
+      else
+        is_valid_checksum = decoded[-1].unpack("C*").first == hash_bytes[0]
+      end
+
+      raise "Invalid decoded address checksum" unless is_valid_checksum && ignore_checksum
+
+      decoded[1...size].unpack("H*").first
+    end
+
+
+    def encode(pubkey, addr_type = 42)
+      pubkey = pubkey[2..-1] if pubkey =~ /^0x/i
+      key = [pubkey].pack("H*")
+
+      u8_array = key.bytes
+
+      u8_array.unshift(addr_type)
+
+      bytes = make_hash(u8_array.pack("C*"))
+      
+      checksum = bytes[0, key.size == 32 ? 2 : 1]
+
+      u8_array.push(*checksum)
+
+      input = u8_array.pack("C*")
+
+      Base58.binary_to_base58(input, :bitcoin)
+    end
+
+    def make_hash(body)
+      Blake2b.bytes("#{SS58_PREFIX}#{body}", Blake2b::Key.none, 64)
+    end
+
+  end
+end