scale.rb 0.2.19 → 0.3.0

data/lib/scale/types.rb

@@ -2,7 +2,7 @@ module Scale
   module Types
 
     class Bool
-      include SingleValue
+      include Base
       BYTES_LENGTH = 1
 
       def self.decode(scale_bytes)
@@ -10,10 +10,10 @@ module Scale
         bytes = scale_bytes.get_next_bytes(self::BYTES_LENGTH)
         if bytes == [0]
           puts "  END " + self::TYPE_NAME + ": #{scale_bytes}" if Scale::Types.debug == true
-          Bool.new(false)
+          new(false)
         elsif bytes == [1]
           puts "  END " + self::TYPE_NAME + ": #{scale_bytes}" if Scale::Types.debug == true
-          Bool.new(true)
+          new(true)
         else
           raise "Bad data"
         end
@@ -24,6 +24,35 @@ module Scale
       end
     end
 
+    class OptionBool
+      include Base
+      def self.decode(scale_bytes)
+        byte = scale_bytes.get_next_bytes(1)[0]
+        value = if byte == 0x00
+                  nil
+                elsif byte == 0x01
+                  true
+                elsif byte == 0x02
+                  false
+                else
+                  raise BadDataError.new("Bad scale data for OptionBool #{byte.to_s(16)}")
+                end
+        new(value)
+      end
+
+      def encode
+        if value.nil?
+          "00"
+        elsif value === true
+          "01"
+        elsif value === false
+          "02"
+        else
+          raise WrongValueError.new("OptionBool can not have value other than `nil`, `true`, `false`")
+        end
+      end
+    end
+
     class U8
       include FixedWidthUInt
       BYTE_LENGTH = 1
@@ -54,6 +83,11 @@ module Scale
       BYTE_LENGTH = 32
     end
 
+    class U512
+      include FixedWidthUInt
+      BYTE_LENGTH = 64
+    end
+
     class I8
       include FixedWidthInt
       BYTE_LENGTH = 1
@@ -80,7 +114,7 @@ module Scale
     end
 
     class Compact
-      include SingleValue
+      include Base
 
       def self.decode(scale_bytes)
         puts "BEGIN " + self::TYPE_NAME + ": #{scale_bytes}" if Scale::Types.debug == true
@@ -118,7 +152,7 @@ module Scale
           end
 
         puts "  END " + self::TYPE_NAME + ": #{scale_bytes}" if Scale::Types.debug == true
-        Compact.new(value)
+        new(value)
       end
 
       def encode
@@ -143,7 +177,7 @@ module Scale
     end
 
     class Bytes
-      include SingleValue
+      include Base
 
       def self.decode(scale_bytes)
         puts "BEGIN " + self::TYPE_NAME + ": #{scale_bytes}" if Scale::Types.debug == true
@@ -155,10 +189,10 @@ module Scale
         str = bytes.pack("C*").force_encoding("utf-8")
         if str.valid_encoding?
           puts "  END " + self::TYPE_NAME + ": #{scale_bytes}" if Scale::Types.debug == true
-          Bytes.new str
+          new str
         else
           puts "  END " + self::TYPE_NAME + ": #{scale_bytes}" if Scale::Types.debug == true
-          Bytes.new bytes.bytes_to_hex
+          new bytes.bytes_to_hex
         end
       end
 
@@ -176,35 +210,40 @@ module Scale
     end
 
     class Hex
-      include SingleValue
+      include Base
 
       def self.decode(scale_bytes)
         puts "BEGIN " + self::TYPE_NAME + ": #{scale_bytes}" if Scale::Types.debug == true
         length = Scale::Types::Compact.decode(scale_bytes).value
         hex_string = scale_bytes.get_next_bytes(length).bytes_to_hex
         puts "  END " + self::TYPE_NAME + ": #{scale_bytes}" if Scale::Types.debug == true
-        Hex.new(hex_string)
+        new(hex_string)
+      end
+
+      def encode
+        length = Compact.new((value.length - 2)/2).encode
+        "#{length}#{value[2..]}"
       end
     end
 
     class String
-      include SingleValue
+      include Base
       def self.decode(scale_bytes)
         puts "BEGIN " + self::TYPE_NAME + ": #{scale_bytes}" if Scale::Types.debug == true
         length = Scale::Types::Compact.decode(scale_bytes).value
         bytes = scale_bytes.get_next_bytes(length)
         puts "  END " + self::TYPE_NAME + ": #{scale_bytes}" if Scale::Types.debug == true
-        String.new bytes.pack("C*").force_encoding("utf-8")
+        new bytes.pack("C*").force_encoding("utf-8")
       end
     end
 
     class H160
-      include SingleValue
+      include Base
       def self.decode(scale_bytes)
         puts "BEGIN " + self::TYPE_NAME + ": #{scale_bytes}" if Scale::Types.debug == true
         bytes = scale_bytes.get_next_bytes(20)
         puts "  END " + self::TYPE_NAME + ": #{scale_bytes}" if Scale::Types.debug == true
-        H160.new(bytes.bytes_to_hex)
+        new(bytes.bytes_to_hex)
       end
 
       def encode
@@ -214,12 +253,12 @@ module Scale
     end
 
     class H256
-      include SingleValue
+      include Base
       def self.decode(scale_bytes)
         puts "BEGIN " + self::TYPE_NAME + ": #{scale_bytes}" if Scale::Types.debug == true
         bytes = scale_bytes.get_next_bytes(32)
         puts "  END " + self::TYPE_NAME + ": #{scale_bytes}" if Scale::Types.debug == true
-        H256.new(bytes.bytes_to_hex)
+        new(bytes.bytes_to_hex)
       end
 
       def encode
@@ -229,12 +268,12 @@ module Scale
     end
 
     class H512
-      include SingleValue
+      include Base
       def self.decode(scale_bytes)
         puts "BEGIN " + self::TYPE_NAME + ": #{scale_bytes}" if Scale::Types.debug == true
         bytes = scale_bytes.get_next_bytes(64)
         puts "  END " + self::TYPE_NAME + ": #{scale_bytes}" if Scale::Types.debug == true
-        H512.new(bytes.bytes_to_hex)
+        new(bytes.bytes_to_hex)
       end
 
       def encode
@@ -244,7 +283,7 @@ module Scale
     end
 
     class GenericAddress
-      include SingleValue
+      include Base
 
       # https://github.com/paritytech/substrate/wiki/External-Address-Format-(SS58)
       # base58encode ( concat ( <address-type>, <address>, <checksum> ) )
@@ -260,7 +299,7 @@ module Scale
           account_length = [account_length].bytes_to_hex
 
           puts "  END " + self::TYPE_NAME + ": #{scale_bytes}" if Scale::Types.debug == true
-          Address.new({
+          new({
             account_id: account_id,
             account_length: account_length
           })
@@ -279,7 +318,7 @@ module Scale
           account_length = [account_length].bytes_to_hex
 
           puts "  END " + self::TYPE_NAME + ": #{scale_bytes}" if Scale::Types.debug == true
-          Address.new({
+          new({
             account_index: account_index,
             account_length: account_length
           })
@@ -302,7 +341,7 @@ module Scale
     class AccountIdAddress < GenericAddress
       def self.decode(scale_bytes)
         puts "BEGIN " + self::TYPE_NAME + ": #{scale_bytes}" if Scale::Types.debug == true
-        result = AccountIdAddress.new({
+        result = new({
           account_id: AccountId.decode(scale_bytes).value,
           account_length: "0xff"
         })
@@ -316,6 +355,17 @@ module Scale
       end
     end
 
+    class GenericMultiAddress
+      include Enum
+      items(
+        Id: "AccountId",
+        Index: "Compact",
+        Raw: "Hex",
+        Address32: "H256",
+        Address20: "H160"
+      )
+    end
+
     class AccountId < H256; end
 
     class Balance < U128; end
@@ -327,14 +377,14 @@ module Scale
     class AccountIndex < U32; end
 
     class Era
-      include SingleValue
+      include Base
       def self.decode(scale_bytes)
         puts "BEGIN " + self::TYPE_NAME + ": #{scale_bytes}" if Scale::Types.debug == true
         byte = scale_bytes.get_next_bytes(1).bytes_to_hex
         result = if byte == "0x00"
-          Era.new byte
+          new byte
         else
-          Era.new byte + scale_bytes.get_next_bytes(1).bytes_to_hex()[2..]
+          new byte + scale_bytes.get_next_bytes(1).bytes_to_hex()[2..]
         end
         puts "  END " + self::TYPE_NAME + ": #{scale_bytes}" if Scale::Types.debug == true
         result
@@ -346,7 +396,7 @@ module Scale
     class Moment < U64; end
 
     class CompactMoment
-      include SingleValue
+      include Base
       def self.decode(scale_bytes)
         puts "BEGIN " + self::TYPE_NAME + ": #{scale_bytes}" if Scale::Types.debug == true
         value = Compact.decode(scale_bytes).value
@@ -355,7 +405,7 @@ module Scale
         end
 
         puts "  END " + self::TYPE_NAME + ": #{scale_bytes}" if Scale::Types.debug == true
-        CompactMoment.new Time.at(value).strftime("%F %T")
+        new Time.at(value).strftime("%F %T")
       end
     end
 
@@ -459,9 +509,9 @@ module Scale
     end
 
     class Null
-      include SingleValue
+      include Base
       def self.decode(scale_bytes)
-        Null.new nil
+        new nil
       end
 
       def encode
@@ -652,20 +702,20 @@ module Scale
       include Struct
       items(
         id: "VecU8Length8",
-        amount: "Balance",
+        amount: "Scale::Types::Balance",
         until: "U32",
-        reasons: "WithdrawReasons"
+        reasons: "Scale::Types::WithdrawReasons"
       )
     end
 
     class EthereumAddress
-      include SingleValue
+      include Base
 
       def self.decode(scale_bytes)
         puts "BEGIN " + self::TYPE_NAME + ": #{scale_bytes}" if Scale::Types.debug == true
         bytes = scale_bytes.get_next_bytes(20)
         puts "  END " + self::TYPE_NAME + ": #{scale_bytes}" if Scale::Types.debug == true
-        EthereumAddress.new(bytes.bytes_to_hex)
+        new(bytes.bytes_to_hex)
       end
 
       def encode
@@ -678,12 +728,12 @@ module Scale
     end
 
     class EcdsaSignature
-      include SingleValue
+      include Base
 
       def self.decode(scale_bytes)
         puts "BEGIN " + self::TYPE_NAME + ": #{scale_bytes}" if Scale::Types.debug == true
         bytes = scale_bytes.get_next_bytes(65)
-        EcdsaSignature.new(bytes.bytes_to_hex)
+        new(bytes.bytes_to_hex)
         puts "  END " + self::TYPE_NAME + ": #{scale_bytes}" if Scale::Types.debug == true
       end
 
@@ -790,7 +840,7 @@ module Scale
     end
 
     class VoteOutcome
-      include SingleValue
+      include Base
       def self.decode(scale_bytes)
         puts "BEGIN " + self::TYPE_NAME + ": #{scale_bytes}" if Scale::Types.debug == true
         result = new(scale_bytes.get_next_bytes(32))
@@ -834,7 +884,7 @@ module Scale
     end
 
     class BoxProposal
-      include SingleValue
+      include Base
 
       def self.decode(scale_bytes, metadata, chain_spec)
         puts "BEGIN " + self::TYPE_NAME + ": #{scale_bytes}" if Scale::Types.debug == true
@@ -872,7 +922,7 @@ module Scale
     end
 
     class VecH512Length2
-      include SingleValue
+      include Base
 
       def self.decode(scale_bytes)
       end
@@ -885,7 +935,7 @@ module Scale
     end
 
     class GenericBlock
-      include SingleValue
+      include Base
 
       def self.decode(scale_bytes)
       end

data/lib/scale/version.rb

@@ -1,3 +1,3 @@
 module Scale
-  VERSION = "0.2.19".freeze
+  VERSION = "0.3.0".freeze
 end

data/lib/scale_bytes.rb

@@ -0,0 +1,63 @@
+module Scale
+  class Bytes
+    attr_reader :data, :bytes
+    attr_reader :offset
+
+    def initialize(data)
+      if (data.class == Array) && data.is_byte_array?
+        @bytes = data
+      elsif (data.class == String) && data.start_with?("0x") && (data.length % 2 == 0)
+        arr = data[2..].scan(/../).map(&:hex)
+        @bytes = arr
+      else
+        raise "Provided data is not valid"
+      end
+
+      @data = data
+      @offset = 0
+    end
+
+    def reset_offset
+      @offset = 0
+    end
+
+    def get_next_bytes(length)
+      result = @bytes[@offset...@offset + length]
+      if result.length < length
+        str = @data[(2 + @offset * 2)..]
+        str = str.length > 40 ? (str[0...40]).to_s + "..." : str
+        raise "No enough data: #{str}, expect length: #{length}, but #{result.length}" 
+      end
+      @offset += length
+      result
+    rescue RangeError => ex
+      puts "length: #{length}"
+      puts ex.message
+      puts ex.backtrace
+    end
+
+    def get_remaining_bytes
+      @bytes[offset..]
+    end
+
+    def to_hex_string
+      @bytes.bytes_to_hex
+    end
+
+    def to_bin_string
+      @bytes.bytes_to_bin
+    end
+
+    def to_ascii 
+      @bytes[0...offset].pack("C*") + "<================================>" + @bytes[offset..].pack("C*")
+    end
+
+    def ==(other)
+      bytes == other.bytes && offset == other.offset
+    end
+
+    def to_s
+      green(@bytes[0...offset].bytes_to_hex) + yellow(@bytes[offset..].bytes_to_hex[2..])
+    end
+  end
+end

data/lib/substrate_client.rb

@@ -39,6 +39,7 @@ class SubstrateClient
     @url = url
     @request_id = 1
     @metadata_cache = {}
+    init_types_and_metadata
   end
 
   def request(method, params)
@@ -136,16 +137,18 @@ class SubstrateClient
     [events_data, decoded]
   end
 
-  # Plain: client.get_storage("Sudo", "Key")
-  # Plain: client.get_storage("Balances", "TotalIssuance")
-  # Map: client.get_storage("System", "Account", ["0xd43593c715fdd31c61141abd04a99fd6822c8558854ccde39a5684e7a56da27d"])
-  # DoubleMap: client.get_storage("ImOnline", "AuthoredBlocks", [2818, "0x749ddc93a65dfec3af27cc7478212cb7d4b0c0357fef35a0163966ab5333b757"])
   def get_storage(module_name, storage_name, params = nil, block_hash = nil)
     self.init_types_and_metadata(block_hash)
 
-    storage_key, return_type = SubstrateClient::Helper.generate_storage_key_from_metadata(@metadata, module_name, storage_name, params)
+    storage_key, return_type, storage_item = SubstrateClient::Helper.generate_storage_key_from_metadata(@metadata, module_name, storage_name, params)
+
     data = self.state_getStorage(storage_key, block_hash)
-    return unless data
+
+    if data.nil?
+      return if storage_item[:modifier] == "Optional"
+
+      data = storage_item[:fallback]
+    end
 
     bytes = Scale::Bytes.new(data)
     type = Scale::Types.get(return_type)