ciri 0.0.1 → 0.0.2

data/{lib → ciri-rlp/lib}/ciri/rlp.rb

@@ -20,7 +20,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-
+require 'ciri/rlp/version'
 require_relative 'rlp/decode'
 require_relative 'rlp/encode'
 require_relative 'rlp/serializable'
@@ -35,4 +35,4 @@ module Ciri
     extend Decode
 
   end
-end
+end

data/ciri-rlp/lib/ciri/rlp/decode.rb

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2018, by Jiang Jinyang. <https://justjjy.com>
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+
+require 'stringio'
+
+module Ciri
+  module RLP
+    module Decode
+
+      # Decode input from rlp encoding, only produce string or array
+      #
+      # Examples:
+      #
+      #   Ciri::RLP.decode(input)
+      #
+      def decode(input, type = Raw)
+        decode_with_type(input, type)
+      end
+
+      # Use this method after RLP.decode, decode values from string or array to specific types
+      # see Ciri::RLP::Serializable::TYPES for supported types
+      #
+      # Examples:
+      #
+      #   item = Ciri::RLP.decode(encoded_text)
+      #   decode_with_type(item, Integer)
+      #
+      def decode_with_type(s, type)
+        s = StringIO.new(s) if s.is_a?(String)
+        if type == Integer
+          item = s.read(1)
+          if item.nil?
+            raise InvalidValueError.new "invalid bool value nil"
+          elsif item == "\x80".b || item.empty?
+            0
+          elsif item.ord < 0x80
+            item.ord
+          else
+            size = item[0].ord - 0x80
+            Ciri::Utils.big_endian_decode(s.read(size))
+          end
+        elsif type == Bool
+          item = s.read(1)
+          if item == Bool::ENCODED_TRUE
+            true
+          elsif item == Bool::ENCODED_FALSE
+            false
+          else
+            raise InvalidValueError.new "invalid bool value #{item}"
+          end
+        elsif type.is_a?(Class) && type.respond_to?(:rlp_decode)
+          type.rlp_decode(s)
+        elsif type.is_a?(Array)
+          decode_list(s) do |list, s2|
+            i = 0
+            until s2.eof?
+              t = type.size > i ? type[i] : type[-1]
+              list << decode_with_type(s2, t)
+              i += 1
+            end
+          end
+        elsif type == Raw
+          decode_stream(s)
+        else
+          raise RLP::InvalidValueError.new "unknown type #{type}"
+        end
+      rescue
+        STDERR.puts "when decoding #{s} into #{type}"
+        raise
+      end
+
+      protected
+
+      def decode_list(s, first_char = nil, &decoder)
+        s = StringIO.new(s) if s.is_a?(String)
+        c = first_char || s.read(1)
+        list = []
+
+        sub_s = case c.ord
+                when 0xc0..0xf7
+                  length = c.ord - 0xc0
+                  s.read(length)
+                when 0xf8..0xff
+                  length_binary = s.read(c.ord - 0xf7)
+                  length = int_from_binary(length_binary)
+                  s.read(length)
+                else
+                  raise InvalidValueError.new("invalid char #{c}")
+                end
+
+        decoder.call(list, StringIO.new(sub_s))
+        list
+      end
+
+      private
+
+      def decode_stream(s)
+        c = s.read(1)
+        case c.ord
+        when 0x00..0x7f
+          c
+        when 0x80..0xb7
+          length = c.ord - 0x80
+          s.read(length)
+        when 0xb8..0xbf
+          length_binary = s.read(c.ord - 0xb7)
+          length = int_from_binary(length_binary)
+          s.read(length)
+        else
+          decode_list(s, c) do |list, s2|
+            until s2.eof?
+              list << decode_stream(s2)
+            end
+          end
+        end
+      end
+
+      def int_from_binary(input)
+        Ciri::Utils.big_endian_decode(input)
+      end
+
+    end
+  end
+end

data/ciri-rlp/lib/ciri/rlp/encode.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2018, by Jiang Jinyang. <https://justjjy.com>
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+
+module Ciri
+  module RLP
+    module Encode
+
+      class InputOverflow < StandardError
+      end
+
+      # Encode input to rlp encoding
+      #
+      # Examples:
+      #
+      #   Ciri::RLP.encode("hello world")
+      #
+      def encode(input, type = nil)
+        type ? encode_with_type(input, type) : encode_simple(input)
+      end
+
+      def encode_simple(input)
+        if input.is_a?(Array)
+          encode_list(input) {|i| encode_simple(i)}
+        elsif input.is_a?(Integer)
+          encode_with_type(input, Integer)
+        elsif input.class.respond_to?(:rlp_encode)
+          input.class.rlp_encode(input)
+        else
+          encode_with_type(input, Raw)
+        end
+      end
+
+      # Use this method before RLP.encode, this method encode ruby objects to rlp friendly format, string or array.
+      # see Ciri::RLP::Serializable::TYPES for supported types
+      #
+      # Examples:
+      #
+      #   item = Ciri::RLP.encode_with_type(number, :int, zero: "\x00".b)
+      #   encoded_text = Ciri::RLP.encode(item)
+      #
+      def encode_with_type(item, type, zero: '')
+        if type == Integer
+          if item == 0
+            "\x80".b
+          elsif item < 0x80
+            Ciri::Utils.big_endian_encode(item, zero)
+          else
+            buf = Ciri::Utils.big_endian_encode(item, zero)
+            [0x80 + buf.size].pack("c*") + buf
+          end
+        elsif type == Bool
+          item ? Bool::ENCODED_TRUE : Bool::ENCODED_FALSE
+        elsif type.is_a?(Class) && type.respond_to?(:rlp_encode)
+          type.rlp_encode(item)
+        elsif type.is_a?(Array)
+          if type.size == 1 # array type
+            encode_list(item) {|i| encode_with_type(i, type[0])}
+          else # unknown
+            raise RLP::InvalidValueError.new "type size should be 1, got #{type}"
+          end
+        elsif type == Raw
+          encode_raw(item)
+        else
+          raise RLP::InvalidValueError.new "unknown type #{type}"
+        end
+      rescue
+        STDERR.puts "when encoding #{Utils.to_hex item.to_s} into #{type}"
+        raise
+      end
+
+      protected
+
+      def encode_raw(input)
+        result = if input.is_a?(String)
+                   encode_string(input)
+                 elsif input.is_a?(Array)
+                   encode_list(input) {|item| encode(item)}
+                 else
+                   raise ArgumentError.new("input must be a String or Array, #{input.inspect}")
+                 end
+        result.b
+      end
+
+      def encode_string(input)
+        length = input.length
+        if length == 1 && input.ord < 0x80
+          input
+        elsif length < 56
+          to_binary(0x80 + length) + input
+        elsif length < 256 ** 8
+          binary_length = to_binary(length)
+          to_binary(0xb7 + binary_length.size) + binary_length + input
+        else
+          raise InputOverflow.new("input length #{input.size} is too long")
+        end
+      end
+
+      def encode_list(input, &encoder)
+        input ||= [] # allow nil list
+        output = encoder ? input.map {|item| encoder.call(item)}.join : input.join
+        length = output.length
+        if length < 56
+          to_binary(0xc0 + length) + output
+        elsif length < 256 ** 8
+          binary_length = to_binary(length)
+          to_binary(0xf7 + binary_length.size) + binary_length + output
+        else
+          raise InputOverflow.new("input length #{input.size} is too long")
+        end
+      end
+
+      private
+
+      def to_binary(n)
+        Ciri::Utils.big_endian_encode(n)
+      end
+
+    end
+  end
+end

data/ciri-rlp/lib/ciri/rlp/serializable.rb

@@ -0,0 +1,241 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2018, by Jiang Jinyang. <https://justjjy.com>
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+
+require 'ciri/utils'
+
+module Ciri
+  module RLP
+
+    # represent bool types: true | false
+    class Bool
+      ENCODED_TRUE = Ciri::Utils.big_endian_encode(0x01)
+      ENCODED_FALSE = Ciri::Utils.big_endian_encode(0x80)
+    end
+
+    # represent RLP raw types, binary or array
+    class Raw
+    end
+
+    # Serializable module allow ruby objects serialize/deserialize to or from RLP encoding.
+    # See Ciri::RLP::Serializable::TYPES for supported type.
+    #
+    # schema method define ordered data structure for class, and determine how to encoding objects.
+    #
+    # schema follow `{attr_name: type}` format,
+    # if attr is raw type(string or array of string), you can just use `:attr_name` to define it
+    # schema simple types include Integer, Bool, String, Array...
+    #
+    # schema also support complex types: array and serializable.
+    #
+    # array types represented as `{attr_name: [type]}`, for example: `{bills: [Integer]}` means value of bill attr is an array of integer
+    # serializable type represent value of attr is a RLP serializable object
+    #
+    #
+    # Examples:
+    #
+    #   class AuthMsgV4
+    #     include Ciri::RLP::Serializable
+    #
+    #     # define schema
+    #     schema [
+    #              :signature, # raw type: string
+    #              {initiator_pubkey: MySerializableKey}, # this attr is a RLP serializable object
+    #              {nonce: [Integer]},
+    #              {version: Integer}
+    #            ]
+    #
+    #     # default values
+    #     default_data(got_plain: false)
+    #   end
+    #
+    #   msg = AuthMsgV4.new(signature: "\x00", initiator_pubkey: my_pubkey, nonce: [1, 2, 3], version: 4)
+    #   encoded = msg.rlp_encode
+    #   msg2 = AuthMsgV4.rlp_decode(encoded)
+    #   msg == msg2 # true
+    #
+    module Serializable
+      # nil represent RLP raw value(string or array of string)
+      TYPES = [Raw, Integer, Bool].map {|key| [key, true]}.to_h.freeze
+
+      # Schema specific columns types of classes, normally you should not use Serializable::Schema directly
+      #
+      class Schema
+        include Encode
+        include Decode
+
+        class InvalidSchemaError < StandardError
+        end
+
+        # keys return data columns array
+        attr_reader :keys
+
+        KeySchema = Struct.new(:type, :options, keyword_init: true)
+
+        def initialize(schema)
+          keys = []
+          @_schema = {}
+
+          schema.each do |key|
+            if key.is_a?(Hash)
+              options = [:optional].map {|o| [o, key.delete(o)]}.to_h
+              raise InvalidSchemaError.new("include unknown options #{key}") unless key.size == 1
+              key, type = key.to_a[0]
+            else
+              options = {}
+              type = Raw
+            end
+            raise InvalidSchemaError.new("missing type #{type} for key #{key}") unless check_key_type(type)
+            keys << key
+            @_schema[key] = KeySchema.new(type: type, options: options)
+          end
+
+          @_schema.freeze
+          @keys = keys.freeze
+        end
+
+        # Get column type, see Serializable::TYPES for supported type
+        def [](key)
+          @_schema[key]
+        end
+
+        # Validate data, data is a Hash
+        def validate!(data)
+          keys.each do |key|
+            raise InvalidSchemaError.new("missing key #{key}") unless data.key?(key)
+          end
+        end
+
+        def rlp_encode(data, skip_keys: nil, white_list_keys: nil)
+          # pre-encode, encode data to rlp compatible format(only string or array)
+          used_keys = if white_list_keys
+                        white_list_keys
+                      elsif skip_keys
+                        keys - skip_keys
+                      else
+                        keys
+                      end
+          data_list = []
+          used_keys.each do |key|
+            value = data[key]
+            next if value.nil? && self[key].options[:optional]
+            data_list << encode_with_type(value, self[key].type)
+          end
+          encode_list(data_list)
+        end
+
+        def rlp_decode(input)
+          values = decode_list(input) do |list, stream|
+            keys.each do |key|
+              # decode data by type
+              next if stream.eof? && self[key].options[:optional]
+              list << decode_with_type(stream, self[key].type)
+            end
+          end
+          # convert to key value hash
+          keys.zip(values).to_h
+        end
+
+        private
+
+        def check_key_type(type)
+          return true if TYPES.key?(type)
+          return true if type.is_a?(Class) && type.respond_to?(:rlp_decode) && type.respond_to?(:rlp_encode)
+
+          if type.is_a?(Array) && type.size == 1
+            check_key_type(type[0])
+          else
+            false
+          end
+        end
+      end
+
+      module ClassMethods
+        # Decode object from input
+        def rlp_decode(input)
+          data = schema.rlp_decode(input)
+          self.new(data)
+        end
+
+        # Encode object to rlp encoding string
+        def rlp_encode(item, skip_keys: nil, white_list_keys: nil)
+          schema.rlp_encode(item.serializable_attributes, skip_keys: skip_keys, white_list_keys: white_list_keys)
+        end
+
+        def schema(data_schema = nil)
+          @data_schema ||= Schema.new(data_schema).tap do |schema|
+            # define attributes methods
+            define_attributes(schema)
+          end
+        end
+
+        def default_data(data = nil)
+          @default_data ||= data
+        end
+
+        private
+
+        def define_attributes(schema)
+          schema.keys.each do |attribute|
+            module_eval <<-ATTR_METHODS
+            def #{attribute}
+              serializable_attributes[:"#{attribute}"]
+            end
+
+            def #{attribute}=(value)
+              serializable_attributes[:"#{attribute}"] = value 
+            end
+            ATTR_METHODS
+          end
+        end
+      end
+
+      class << self
+        def included(base)
+          base.send :extend, ClassMethods
+        end
+      end
+
+      attr_reader :serializable_attributes
+
+      def initialize(**data)
+        @serializable_attributes = (self.class.default_data || {}).merge(data)
+        self.class.schema.validate!(@serializable_attributes)
+      end
+
+      def initialize_copy(orig)
+        super
+        @serializable_attributes = orig.serializable_attributes.dup
+      end
+
+      # Encode object to rlp encoding string
+      def rlp_encode(skip_keys: nil, white_list_keys: nil)
+        self.class.rlp_encode(self, skip_keys: skip_keys, white_list_keys: white_list_keys)
+      end
+
+      def ==(other)
+        self.class == other.class && serializable_attributes == other.serializable_attributes
+      end
+
+    end
+  end
+end