ssz 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e90d345e757920b0e658c21302c92cc6bef8a8ca45dddc9cd05dfc4a979d2516
+  data.tar.gz: bcd166173f3156c77f882188d66ec7f53e2f978808238d3f8ba4582b55977d46
+SHA512:
+  metadata.gz: c6e26a1d8a49db7ccfcf597e82dfcda701a6dc5e9f7a39350ea6720354c5ded63f9c325507f48157717792b0743386a3cc5c7b14ba0bb79375a3d5457ee2c8dd
+  data.tar.gz: 722e879df0fe33a4499f45985a2fd0070e3c60a36f125de562d359d0d8d330cce1c401feb66255e5cd1e49642aadadcee0114e709a039ff3a83ea228235ecc75

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.1.0.pre.2

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in ssz-rb.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Kai Chen
+
+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,44 @@
+# SSZ
+
+**S**imple **S**eriali**Z**e implemented in Ruby programming language.
+
+It's a data serialization format, to replace [RLP](https://github.com/ethereum/wiki/wiki/RLP), used in [eth2](https://github.com/ethereum/eth2.0-specs).
+
+* <https://github.com/ethereum/eth2.0-specs/blob/dev/specs/simple-serialize.md>
+* <https://ethresear.ch/t/replacing-ssz-with-rlp-zip-and-sha256/5706>
+* <https://rauljordan.com/2019/07/02/go-lessons-from-writing-a-serialization-library-for-ethereum.html>
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ssz-rb'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install ssz-rb
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/kaichen/ssz-rb.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ssz/rb"
+
+# 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/lib/ssz.rb

@@ -0,0 +1,12 @@
+require "ssz/version"
+require_relative './ssz/boolean'
+require_relative './ssz/uint'
+require_relative './ssz/bit_victor'
+require_relative './ssz/bit_list'
+require_relative './ssz/byte_buffer'
+require_relative './ssz/victor'
+
+module Ssz
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/ssz/base.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative './fixed_sized'
+
+module Ssz
+  class Base
+    include FixedSized
+  end
+end

data/lib/ssz/bit_list.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative './base'
+
+module Ssz
+  class BitList < Base
+    def initialize(bits, capacity:)
+      @capacity = capacity
+      @bits = bits
+    end
+
+    def serialize
+      bb = ByteBuffer.from_bit_array(@bits.map{|b| b ? 1 : 0})
+      bb.bytes << 0 if bb.bytes.size < (@bits.size / 8) + 1 # extend buffer size
+      bb.bytes[@bits.size / 8] |= 1 << (@bits.size % 8)
+      bb.serialize
+    end
+  end
+end

data/lib/ssz/bit_victor.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative './base'
+
+module Ssz
+  class BitVictor < Base
+    def initialize(bits, capacity:)
+      @capacity = capacity
+      @bits = bits
+    end
+
+    def serialize
+      ByteBuffer.from_bit_array(@bits.map{|b| b ? 1 : 0}).serialize
+    end
+  end
+end

data/lib/ssz/boolean.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative './base'
+
+module Ssz
+  class Boolean < Base
+    def initialize(bool)
+      @bool = bool
+    end
+
+    def serialize
+      Array(@bool ? 1 : 0).pack("C")
+    end
+
+    def size
+      1
+    end
+  end
+end

data/lib/ssz/byte_buffer.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Ssz
+  # @example:
+  #   ByteBuffer.from_bit_array([1, 0, 0, 0]).bytes #=> "\x01"
+  class ByteBuffer
+    attr_accessor :bytes
+
+    def initialize(n = 0)
+      @bytes = [0] * n
+    end
+
+    def self.from_bit_array(bits)
+      byte_size = bits.size < 8 ? 1 : (bits.size / 8.0).ceil
+      bb = ByteBuffer.new(byte_size)
+      bb.bits = bits
+      bb
+    end
+
+    def bits=(bits)
+      byte_size = bits.size < 8 ? 1 : (bits.size / 8.0).ceil
+      # fill 0 to fix byte(8-bits)
+      while (byte_size * 8) != bits.size do
+        bits << 0
+      end
+      bits.each_with_index do |b, i|
+        @bytes[i / 8] |= b << (i % 8)
+      end
+      bits
+    end
+
+    def serialize
+      @bytes.pack("C*")
+    end
+
+    def length
+      @bytes.length
+    end
+
+    def bit_size
+      length * 8
+    end
+  end
+end

data/lib/ssz/fixed_sized.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Ssz
+  module FixedSized
+    def fixed_sized?
+      [Boolean, BitVictor, Victor, Uint].include? self.class
+    end
+  end
+end

data/lib/ssz/uint.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative './base'
+
+module Ssz
+  class Uint < Base
+    def initialize(num, length: 8)
+      @num = num
+      @data_length = length
+      # TODO: validate length
+    end
+
+    def serialize
+      byte_size = (@data_length / 8)
+      # FIXME: better way convert integer to bytes
+      hex = @num.to_s(16)
+      hex = "0#{hex}" if hex.size % 2 != 0
+      bytes = hex.scan(/.{2}/)
+      if bytes.length < byte_size
+        bytes = ["0"] * (byte_size - bytes.length) + bytes
+      end
+      bytes.map { |str| str.to_i(16) }.pack("C" * byte_size).force_encoding("ASCII-8BIT")
+    end
+
+    def size
+      serialize.size
+    end
+  end
+end

data/lib/ssz/version.rb

@@ -0,0 +1,3 @@
+module Ssz
+  VERSION = "0.1.0"
+end

data/lib/ssz/victor.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative './base'
+
+module Ssz
+  class Victor < Base
+    attr_reader :size
+
+    def initialize(element_type, size)
+      @element_type = element_type
+      @items = []
+      @size = size
+    end
+  end
+end

data/ssz.gemspec

@@ -0,0 +1,26 @@
+require_relative 'lib/ssz/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ssz"
+  spec.version       = Ssz::VERSION
+  spec.authors       = ["Kai Chen"]
+  spec.email         = ["kai@thekaiway.com"]
+
+  spec.summary       = %q{Simple serialization implementation in Ruby}
+  spec.homepage      = "https://github.com/kaichen/ssz-rb"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = "https://github.com/kaichen/ssz-rb"
+  spec.metadata["source_code_uri"] = "https://github.com/kaichen/ssz-rb"
+  spec.metadata["changelog_uri"] = "https://github.com/kaichen/ssz-rb/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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"]
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: ssz
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kai Chen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-11-02 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- kai@thekaiway.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ssz.rb
+- lib/ssz/base.rb
+- lib/ssz/bit_list.rb
+- lib/ssz/bit_victor.rb
+- lib/ssz/boolean.rb
+- lib/ssz/byte_buffer.rb
+- lib/ssz/fixed_sized.rb
+- lib/ssz/uint.rb
+- lib/ssz/version.rb
+- lib/ssz/victor.rb
+- ssz.gemspec
+homepage: https://github.com/kaichen/ssz-rb
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/kaichen/ssz-rb
+  source_code_uri: https://github.com/kaichen/ssz-rb
+  changelog_uri: https://github.com/kaichen/ssz-rb/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Simple serialization implementation in Ruby
+test_files: []