ciri-rlp 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d771c9588988901adee213e5700b8b100bc4b1b80adafa6c6c28e24df094fca4
+  data.tar.gz: 0d01028c1512e74539c428636f8488b111be6084121301e7c96f979d52e7cb73
+SHA512:
+  metadata.gz: 2c18f633b26c0df808aac1da26702f6c2bedc783e141e9c30d38c1608461815c01a3f10e6e6514c4092baffb796c2718af9b11d91079c79a5c09f830602402e6
+  data.tar.gz: 3d9d8687593c7aaea68712abce4e558bfaabea2218721aa34a6087b8c4699ba2515ff49e164d415423a1f704a259cf6180ef78b09386193a0491976994947d32

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at jjyruby@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Jiang Jinyang
+
+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.

data/README.md

@@ -0,0 +1,98 @@
+# Ciri::RLP
+
+The Ruby RLP serialization library.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ciri-rlp'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ciri-rlp
+
+## Usage
+
+Simple use:
+
+```ruby
+# encode
+Ciri::RLP.encode(3)
+Ciri::RLP.encode(["cat", 1, "dog", 3])
+# decode
+Ciri::RLP.decode("rlp encoded content")
+```
+
+Structure:
+```ruby
+# declare a RLP structure
+class Doge
+  include Ciri::RLP::Serializable
+  
+  # RLP is a low level encoding format, only support string(bytes) and list.
+  # so we use a list to present structure data
+  # we also need to declare column type clearly if column is not string
+  schema [
+    :name,
+    {age: Integer}, # declare age is a Integer type
+    :gender,
+    {has_master: Ciri::RLP::Bool} # dechare bool
+  ]
+end
+
+doge = Doge.new(name: 'neo doge', age: 5, gender: "boy", has_master: false)
+# use auto generated encode method
+encoded = Doge.rlp_encode(doge)
+Doge.rlp_decode(encoded) == doge 
+# => true
+```
+
+Customize:
+```ruby
+class DogeList
+  attr_reader :doges
+  
+  def initialize(doges)
+    @doges = doges
+  end
+  
+  # provide two class methods: rlp_encode and rlp_decode to customize RLP behaviour
+  # ciri-rlp will consider duck-typing and invoke those methods 
+  # customize RLP class can be member of other RLP struct
+  def self.rlp_encode(doge_list)
+    # [Doge] represent the encode data is an array of Doge 
+    Ciri::RLP.encode(doge_list.doges, [Doge])
+  end
+  
+  def self.rlp_decode(encoded)
+    doges = Ciri::RLP.decode(encoded, [Doge])
+    DogeList.new(doges)
+  end
+end
+
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ciri-rlp. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Ciri::Rlp project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/ciri-rlp/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ciri/rlp"
+
+# 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"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ciri-rlp.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ciri/rlp/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ciri-rlp"
+  spec.version       = Ciri::Rlp::VERSION
+  spec.authors       = ["Jiang Jinyang"]
+  spec.email         = ["jjyruby@gmail.com"]
+
+  spec.summary       = %q{The RLP serialization library.}
+  spec.description   = %q{Provide simple and structure RLP serialization.}
+  spec.homepage      = "https://github.com/ciri-ethereum/ciri"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "ciri-utils", "~> 0.1.0"
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/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/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/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

data/lib/ciri/rlp/version.rb

@@ -0,0 +1,5 @@
+module Ciri
+  module Rlp
+    VERSION = "0.1.0"
+  end
+end

data/lib/ciri/rlp.rb

@@ -0,0 +1,38 @@
+# 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/rlp/version'
+require_relative 'rlp/decode'
+require_relative 'rlp/encode'
+require_relative 'rlp/serializable'
+
+module Ciri
+  module RLP
+
+    class InvalidValueError < StandardError
+    end
+
+    extend Encode
+    extend Decode
+
+  end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: ciri-rlp
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jiang Jinyang
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-07-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ciri-utils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Provide simple and structure RLP serialization.
+email:
+- jjyruby@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ciri-rlp.gemspec
+- lib/ciri/rlp.rb
+- lib/ciri/rlp/decode.rb
+- lib/ciri/rlp/encode.rb
+- lib/ciri/rlp/serializable.rb
+- lib/ciri/rlp/version.rb
+homepage: https://github.com/ciri-ethereum/ciri
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: The RLP serialization library.
+test_files: []