ciri 0.0.1 → 0.0.2

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

@@ -0,0 +1,5 @@
+module Ciri
+  module RLP
+    VERSION = "0.1.1"
+  end
+end

data/ciri-rlp/spec/ciri/fixture_spec.rb

@@ -0,0 +1,95 @@
+# 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 'spec_helper'
+require 'json'
+require 'ciri/rlp'
+require 'ciri/utils'
+
+RSpec.describe Ciri::RLP do
+
+  fixture_path = File.join(File.dirname(__FILE__), "..", "..", "..", "fixtures")
+
+  before(:all) do
+    `git submodule init #{fixture_path}`
+    `git submodule update #{fixture_path}`
+  end
+
+  decode_types = proc do |value|
+    if value.is_a?(Array)
+      value.map {|i| decode_types[i]}
+    elsif value.is_a?(String)
+      Ciri::RLP::Raw
+    else
+      value.class
+    end
+  end
+
+  skip_tests = %w{
+  }.map {|f| [f, true]}.to_h
+
+  run_test_case = proc do |test_case, prefix: nil, tags: {}|
+    test_case.each do |name, t|
+      tags2 = tags.dup
+
+      if skip_tests.include?(name)
+        tags2[:skip] = true
+      end
+
+      it "#{prefix} #{name}", **tags2 do
+        # in
+        in_value = t['in']
+        if in_value.is_a?(String) && in_value.start_with?('#')
+          in_value = in_value[1..-1].to_i
+        end
+        out_value = t['out']
+
+        if in_value == 'INVALID'
+          expect {
+            rlp_decoded = Ciri::RLP.decode(Ciri::Utils.to_bytes out_value)
+            if Ciri::Utils.to_hex(Ciri::RLP.encode(rlp_decoded)) != out_value
+              raise Ciri::RLP::InvalidValueError, "not invalid encoding"
+            end
+          }.to raise_error(Ciri::RLP::InvalidValueError)
+        elsif in_value == 'VALID'
+          expect {Ciri::RLP.decode(Ciri::Utils.to_bytes out_value)}.to_not raise_error
+        else
+          rlp_encoded = Ciri::RLP.encode(in_value)
+          expect(Ciri::Utils.to_hex(rlp_encoded)[2..-1]).to eq out_value
+
+          rlp_decoded = Ciri::RLP.decode(Ciri::Utils.to_bytes(out_value), decode_types[in_value])
+          expect(rlp_decoded).to eq in_value
+        end
+
+      end
+
+    end
+  end
+
+  Dir.glob("#{fixture_path}/RLPTests/**/*.json").each do |topic|
+    tags = {}
+
+    run_test_case[JSON.load(open topic), prefix: 'fixtures/RLPTests', tags: tags]
+  end
+
+end

data/ciri-rlp/spec/ciri/rlp/decode_spec.rb

@@ -0,0 +1,68 @@
+require 'ciri/rlp'
+
+RSpec.describe Ciri::RLP::Decode do
+
+  context 'numbers' do
+    it '0x00' do
+      expect(Ciri::RLP.decode("\x00".b)).to eq "\x00"
+    end
+
+    it '0x0f' do
+      expect(Ciri::RLP.decode("\x0f".b)).to eq "\x0f"
+    end
+
+    it '1024' do
+      expect(Ciri::RLP.decode("\x82\x04\x00".b)).to eq "\x04\x00"
+    end
+  end
+
+  context 'decode strings' do
+    it 'single byte' do
+      expect(Ciri::RLP.decode('a'.b)).to eq 'a'
+    end
+
+    it 'simple string' do
+      expect(Ciri::RLP.decode("\x83dog")).to eq 'dog'.b
+    end
+
+    it 'empty' do
+      expect(Ciri::RLP.decode("\x80")).to eq ''
+    end
+
+    it 'long string' do
+      expect(Ciri::RLP.decode("\xb8\x38Lorem ipsum dolor sit amet, consectetur adipisicing elit".b)).to eq 'Lorem ipsum dolor sit amet, consectetur adipisicing elit'
+    end
+  end
+
+  context 'decode lists' do
+    it 'list of strings' do
+      expect(Ciri::RLP.decode("\xc8\x83cat\x83dog".b)).to eq ["cat", "dog"]
+    end
+
+    it 'empty list' do
+      expect(Ciri::RLP.decode("\xc0")).to eq []
+    end
+
+    it "empty lists" do
+      expect(Ciri::RLP.decode("\xc7\xc0\xc1\xc0\xc3\xc0\xc1\xc0")).to eq [[], [[]], [[], [[]]]]
+    end
+  end
+
+  context 'decode int' do
+    it '0' do
+      expect(Ciri::RLP.decode_with_type("\x80".b, Integer)).to eq 0
+    end
+
+    it '127' do
+      expect(Ciri::RLP.decode_with_type("\x7f".b, Integer)).to eq 127
+    end
+
+    it '128' do
+      expect(Ciri::RLP.decode_with_type("\x81\x80".b, Integer)).to eq 128
+    end
+
+    it '1024' do
+      expect(Ciri::RLP.decode_with_type("\x82\x04\x00".b, Integer)).to eq 1024
+    end
+  end
+end

data/ciri-rlp/spec/ciri/rlp/encode_spec.rb

@@ -0,0 +1,72 @@
+require 'ciri/rlp'
+
+RSpec.describe Ciri::RLP::Encode do
+
+  context 'numbers' do
+    it '0x00' do
+      expect(Ciri::RLP.encode("\x00")).to eq "\x00"
+    end
+
+    it '0x0f' do
+      expect(Ciri::RLP.encode("\x0f")).to eq "\x0f"
+    end
+
+    it '1024' do
+      expect(Ciri::RLP.encode("\x04\x00")).to eq "\x82\x04\x00".b
+    end
+  end
+
+  context 'encode strings' do
+    it 'single byte' do
+      expect(Ciri::RLP.encode('a')).to eq 'a'.b
+    end
+
+    it 'simple string' do
+      expect(Ciri::RLP.encode('dog')).to eq "\x83dog".b
+    end
+
+    it 'empty' do
+      expect(Ciri::RLP.encode('')).to eq "\x80".b
+    end
+
+    it 'long string' do
+      expect(Ciri::RLP.encode('Lorem ipsum dolor sit amet, consectetur adipisicing elit')).to eq "\xb8\x38Lorem ipsum dolor sit amet, consectetur adipisicing elit".b
+    end
+  end
+
+  context 'encode lists' do
+    it 'list of strings' do
+      expect(Ciri::RLP.encode(["cat", "dog"])).to eq "\xc8\x83cat\x83dog".b
+    end
+
+    it 'empty list' do
+      expect(Ciri::RLP.encode([])).to eq "\xc0".b
+    end
+
+    it "empty lists" do
+      expect(Ciri::RLP.encode([[], [[]], [[], [[]]]])).to eq "\xc7\xc0\xc1\xc0\xc3\xc0\xc1\xc0".b
+    end
+  end
+
+  context 'encode int' do
+    it '0' do
+      expect(Ciri::RLP.encode_with_type(0, Integer)).to eq "\x80".b
+    end
+
+    it '127' do
+      expect(Ciri::RLP.encode_with_type(127, Integer)).to eq "\x7f".b
+    end
+
+    it '128' do
+      expect(Ciri::RLP.encode_with_type(128, Integer)).to eq "\x81\x80".b
+    end
+
+    it '1024' do
+      expect(Ciri::RLP.encode_with_type(1024, Integer)).to eq "\x82\x04\x00".b
+    end
+
+    it '1833967303248889' do
+      expect(Ciri::RLP.encode_with_type(1833967303248889, Integer)).to eq Ciri::Utils.to_bytes("870683FBC9A3CBF9")
+    end
+  end
+end

data/ciri-rlp/spec/ciri/rlp/serializable_spec.rb

@@ -0,0 +1,147 @@
+# 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'
+require 'ciri/rlp/serializable'
+
+RSpec.describe Ciri::RLP::Serializable do
+
+  let(:my_class) {
+    Class.new do
+      include Ciri::RLP::Serializable
+
+      schema [
+               :signature,
+               {nonce: [Integer]},
+               {version: Integer}
+             ]
+      default_data(version: 1)
+    end
+  }
+
+  it 'apply default value' do
+    msg = my_class.new(signature: '123', nonce: [1, 2, 3], version: 4)
+    expect(msg.version).to eq 4
+    msg = my_class.new(signature: '123', nonce: [1, 2, 3])
+    expect(msg.version).to eq 1
+  end
+
+  it 'raise invalid if missing key' do
+    expect do
+      my_class.new(signature: '123')
+    end.to raise_error(Ciri::RLP::Serializable::Schema::InvalidSchemaError)
+  end
+
+  it 'rlp encoding/decoding' do
+    msg = my_class.new(signature: '123', nonce: [1, 2, 3], version: 4)
+    binary = msg.rlp_encode
+    # is valid RLP encoding format
+    expect {Ciri::RLP.decode(binary)}.to_not raise_error
+
+    decoded_msg = my_class.rlp_decode(binary)
+    expect(decoded_msg).to eq msg
+  end
+
+  context 'deserialize real world geth handshake' do
+    it 'decode handshake' do
+      my_cap = Class.new do
+        include Ciri::RLP::Serializable
+
+        schema [
+                 :name,
+                 {version: Integer}
+               ]
+      end
+
+      my_protocol_handshake = Class.new do
+        include Ciri::RLP::Serializable
+
+        schema [
+                 {version: Integer},
+                 :name,
+                 {caps: [my_cap]},
+                 {listen_port: Integer},
+                 :id
+               ]
+      end
+
+      encoded_handshake = ['f87d05b1476574682f76312e382e372d756e737461626c652d38366265393162332f64617277696e2d616d6436342f676f312e3130c6c5836574683f80b840da982df3c882252c126ac3ee8fa008ade932c4166dfdc7c117c9852b5df0c6ddcf34bf2555a38596268b3b6bcbdaf48bba57b84a1abc400b4ba65c59ee5342c3'].pack("H*")
+      hs = my_protocol_handshake.rlp_decode(encoded_handshake)
+      expect(hs.version).to eq 5
+      expect(hs.listen_port).to eq 0
+      expect(hs.caps[0].name).to eq 'eth'
+    end
+
+    it 'decode eth getBlockHashes' do
+      get_block_hashes = Class.new do
+        include Ciri::RLP::Serializable
+        CODE = 0x03
+        schema [
+                 {hash_or_number: Integer},
+                 {amount: Integer},
+                 {skip: Integer},
+                 {reverse: Ciri::RLP::Bool},
+               ]
+      end
+
+      encoded_handshake = ['c7831d4c00018080'].pack("H*")
+      msg = get_block_hashes.rlp_decode(encoded_handshake)
+      expect(msg.hash_or_number).to eq 1920000
+      expect(msg.amount).to eq 1
+      expect(msg.skip).to eq 0
+      expect(msg.reverse).to be_falsey
+    end
+  end
+
+  context 'self consistent' do
+    let(:raw_headers) {'f90213f90210a0e48ecfcb38189b103f389a719b782325bdf0f5c005871ea91cd11a52c30ac37ea01dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d4934794829bd824b016326a401d083b33d092293333a830a07007e575a80584487653324053b8ef65cd843fd09d7805eec9d8b840ba60e202a0abf18050f443bdc29bff9a959cb48bdf060861b89662484010ecbb0fdd8d3d9da07129bfc1aefeff683decb5060a00e2d002a2e2934516092aa34d6d62bdb3406fb901000000000000000010000200000000020200002000000000000d100000000000000000000000000000000000000040000200000100000040d00000000000000400000000000802040000000008000000100000000000200000000002000000000000000004020000000000084000000800002000000080000000000114001800000000020000000000800002000000000000000000008008000002000000000100008000000000000000000000400000000000000000400000000000000000000000000002000000000000000000000000008000000012000420000000800020000100000080000000000000000000000000000000000000000000000001000000870683fbc9a3cbf9833ffa818366251183173f8284599d077c8fe4b883e5bda9e7a59ee4bb99e9b1bca0b9566fe1fe4ae4b237a54955b88cc990e64013d1bed4761b32fbd45742825d4488d50741500da57701'}
+    let(:my_header) {
+      Class.new do
+        include Ciri::RLP::Serializable
+
+        schema [
+                 :parent_hash,
+                 :ommers_hash,
+                 :beneficiary,
+                 :state_root,
+                 :transactions_root,
+                 :receipts_root,
+                 :logs_bloom,
+                 {difficulty: Integer},
+                 {number: Integer},
+                 {gas_limit: Integer},
+                 {gas_used: Integer},
+                 {timestamp: Integer},
+                 :extra_data,
+                 :mix_hash,
+                 :nonce,
+               ]
+      end
+    }
+
+    it 'decode then encode again' do
+      raw_headers_b = [raw_headers].pack("H*")
+      headers = Ciri::RLP.decode(raw_headers_b, [my_header])
+      expect(Ciri::RLP.encode(headers, [my_header]).unpack("H*")[0]).to eq raw_headers
+    end
+  end
+
+end

data/ciri-rlp/spec/ciri/rlp_spec.rb

@@ -0,0 +1,5 @@
+RSpec.describe Ciri::RLP do
+  it "has a version number" do
+    expect(Ciri::RLP::VERSION).not_to be nil
+  end
+end

data/ciri-rlp/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require "bundler/setup"
+require "ciri/rlp"
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

data/ciri-utils/.gitignore

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

data/ciri-utils/.rspec

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

data/ciri-utils/.travis.yml

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

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