ciri 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: abe8d78482df9ed72840456def4146338c14d14fe797d8a97ff8bbe1a93f1243
-  data.tar.gz: 65f245e4ec4aa14c2747745976a350ceee764c08f8e010e6586e6c8ba5a57227
+  metadata.gz: 79b86b70c40c6e0e6ae7cf040d0340a3654dde749da125c70071a67ea01a364c
+  data.tar.gz: 00e83d22eb0f8a09218b8100e191502bbfb4268d9345c16980b0881f40cea8ac
 SHA512:
-  metadata.gz: 478a4f654e958caa242c46881120d7737a7b74a72f142a05e29ea83fa32daef22d0a63832f9fc4ef649c9a8860e3be5226a376304d52de78ac1ec1e9ad1005b2
-  data.tar.gz: 556717e91e6dd17e22aeadd6c9f322ffd7d95540bbfcb9bfa775acdafa63a31e149bba971dd4e03ea935eba24d5f3a4f77bde2ba52c0bbe2e2f32b872c86afad
+  metadata.gz: 711c38086e60f8ba9b479763dd5becb5c61e99af0f85da264310418a0a9c85d8e441f351cc098ad614c401c066987e7677f61c6e7519859f3e5f6578b59915fc
+  data.tar.gz: 1fe25627eed64044fb5d6b97edf8735b6a77de1001c515dbbf1257a47760a45dbe95a9c7b0631beeed75391eedcfba98845cc7d45570907116f8b1f50c3b34a6

data/Gemfile.lock

@@ -1,13 +1,18 @@
 PATH
   remote: .
   specs:
-    ciri (0.0.0)
+    ciri (0.0.2)
       bitcoin-secp256k1 (~> 0.4.0)
+      ciri-rlp (~> 0.1.1)
+      ciri-utils (~> 0.1.0)
       concurrent-ruby (~> 1.0.5)
-      digest-sha3 (~> 1.1.0)
       ffi (~> 1.9.23)
       lru_redux (~> 1.1.0)
       snappy (~> 0.0.17)
+    ciri-rlp (0.1.1)
+      ciri-utils (~> 0.1.0)
+    ciri-utils (0.1.0)
+      digest-sha3 (~> 1.1.0)
 
 GEM
   remote: https://rubygems.org/
@@ -17,7 +22,7 @@ GEM
     concurrent-ruby (1.0.5)
     diff-lcs (1.3)
     digest-sha3 (1.1.0)
-    ffi (1.9.23)
+    ffi (1.9.25)
     lru_redux (1.1.0)
     rake (10.3.2)
     rspec (3.7.0)

data/README.md

@@ -12,6 +12,11 @@ Talk to me on [gitter](https://gitter.im/ciri-ethereum/Lobby) if you interesting
 
 See [projects](https://github.com/ciri-ethereum/ciri/projects) and [milestones](https://github.com/ciri-ethereum/ciri/milestones) for current development status.
 
+Roadmap
+---------------
+
+See [Wiki Roadmap](https://github.com/ciri-ethereum/ciri/wiki)
+
 Installation
 ---------------
 

data/Rakefile

@@ -12,18 +12,38 @@ rescue LoadError
   nil
 end
 
+SUB_COMPONENTS = %w{ciri-utils ciri-rlp}
+
+desc 'run tests'
+task :test do
+  exit $?.exitstatus unless system("rspec -t ~slow_tests")
+  SUB_COMPONENTS.each do |dir|
+    puts `cd #{dir} && rake`
+  end
+end
+
+desc 'run all tests, include extreme slow tests'
+task :"test:all" do
+  exit $?.exitstatus unless system("rspec")
+  SUB_COMPONENTS.each do |dir|
+    puts `cd #{dir} && rake`
+  end
+end
+
 namespace :docker do
   base_image = 'ciriethereum/base'
 
   desc 'pull base docker image'
   task :pull_base do
     system("docker pull #{base_image}:latest")
+    exit $?.exitstatus
   end
 
   desc 'build base docker image, rerun this task after updated Gemfile or Dockerfile'
   task :build_base do
     system("git submodule init && git submodule update")
     system("docker build . -f docker/Base -t #{base_image}:latest")
+    exit $?.exitstatus
   end
 
   desc 'open Ciri develop container shell'
@@ -39,11 +59,13 @@ namespace :docker do
 
   desc 'run tests in docker'
   task :test do
-    system("docker run -v `pwd`:/app --rm #{base_image}:latest rspec -t ~slow_tests")
+    system("docker run -v `pwd`:/app --rm #{base_image}:latest rake test")
+    exit $?.exitstatus
   end
 
   desc 'run all tests(include slow tests) in docker'
   task :"test:all" do
-    system("docker run -v `pwd`:/app --rm #{base_image}:latest rspec")
+    system("docker run -v `pwd`:/app --rm #{base_image}:latest rake test:all")
+    exit $?.exitstatus
   end
 end

data/ciri-rlp/.gitignore

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

data/ciri-rlp/.rspec

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

data/ciri-rlp/.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-rlp/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/ciri-rlp/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/ciri-rlp/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    ciri-rlp (0.1.1)
+      ciri-utils (~> 0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ciri-utils (0.1.0)
+      digest-sha3 (~> 1.1.0)
+    diff-lcs (1.3)
+    digest-sha3 (1.1.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  ciri-rlp!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/ciri-rlp/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/ciri-rlp/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/ciri-rlp/Rakefile

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

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