ciri 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61fa52ad5872fda629e5eb32e0d6af81626e3ba2496d63bb5bd74f33abce933f
-  data.tar.gz: e0d6afeff09d16e2e052c7c7579c6bb969d16303d5f5fbefe5f7029c3eafde3f
+  metadata.gz: 20618c56ec07fac482c96e6a4bd5cdb3f3bfb45402be5548e748994283246c99
+  data.tar.gz: d76e2848328eb6a42b4bd0705aaf20885a44cbb0b487b1d4a485fff92f0dd42a
 SHA512:
-  metadata.gz: 50bf9082352959c511d99d67556a33d700ba7e241e4302a46f75be1017d23340ac09bf0f77c4479f9fee8ab418da89ee5893a6349a9f2baa82b56a6755b71517
-  data.tar.gz: 1f2a10fcccbe305d97233bf5270bbc20a63206e57facd77fb415eb29e5aff0450f34826821797aacfe076f0888af0c7152329d7f06c7cc2b56474d2abda0e717
+  metadata.gz: 665f5f8f3d6437c24993c4e2f573b805886906a70f9a0fec5610eec0a5c870ce5d8d8b72558212b5600ba3c9f23f9a29287d2d53bdc85c91623caf8cc487dbc5
+  data.tar.gz: b16a58be1b92f544c2670a2c6956b2943d14f5f5cc1ffc05a3be3f148578049754a2bfc146372f20e493fb127bda8668c2e2174d304a82bb42cd27d26dc7b1e4

data/.travis.yml

@@ -5,8 +5,8 @@ services:
   - docker
 
 before_install:
-  - docker pull ciriethereum/base:latest
+  - docker pull ciriethereum/ciri:latest
   - gem install rake
 
 script:
-  - rake docker:test
+  - rake docker:quick

data/Gemfile.lock

@@ -1,11 +1,11 @@
 PATH
   remote: .
   specs:
-    ciri (0.0.3)
+    ciri (0.0.4)
       bitcoin-secp256k1 (~> 0.4.0)
       ciri-crypto (~> 0.1.1)
-      ciri-rlp (~> 0.1.1)
-      ciri-utils (~> 0.2.0)
+      ciri-rlp (~> 0.2.1)
+      ciri-utils (~> 0.2.1)
       concurrent-ruby (~> 1.0.5)
       ffi (~> 1.9.23)
       lru_redux (~> 1.1.0)
@@ -13,9 +13,9 @@ PATH
     ciri-crypto (0.1.1)
       bitcoin-secp256k1 (~> 0.4.0)
       ciri-utils (~> 0.2.0)
-    ciri-rlp (0.1.1)
-      ciri-utils (~> 0.2.0)
-    ciri-utils (0.2.0)
+    ciri-rlp (0.2.1)
+      ciri-utils (~> 0.2.1)
+    ciri-utils (0.2.1)
       digest-sha3 (~> 1.1.0)
 
 GEM

data/README.md

@@ -3,32 +3,79 @@ Ciri
 [![Build Status](https://travis-ci.org/ciri-ethereum/ciri.svg?branch=master)](https://travis-ci.org/ciri-ethereum/ciri)
 [![Gitter](https://badges.gitter.im/join.svg)](https://gitter.im/ciri-ethereum/Lobby)
 
-Ciri ethereum is intended to build as a full feature set ethereum implementation.
+Ciri is an ongoing Ethereum implementation.
 
-It aims to be a feature complete, long maintained and stable ethereum implementation.
-As you see it'is still under development.
+It aims to be a feature complete Ethereum implementation and expects to achieve both research-friendly and high-performance.
+As you see, it's still under development.
 
-Talk to me on [gitter](https://gitter.im/ciri-ethereum/Lobby) if you interesting in this project or want to contributing. See [How to learn Ethereum and contibute to Ciri](https://github.com/ciri-ethereum/ciri/wiki#how-to-learn-ethereum-and-contribute-to-ciri).
+See [How to learn Ethereum and contribute to Ciri](https://github.com/ciri-ethereum/ciri/wiki#how-to-learn-ethereum-and-contribute-to-ciri).
 
 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)
-
-Documentation
----------------
-
-[YARD documentation](https://www.rubydoc.info/github/ciri-ethereum/ciri/master)
+See [Roadmap](https://github.com/ciri-ethereum/ciri/wiki)  on Wiki
 
 Development
 ---------------
 
 Ciri depends on [rocksdb](https://github.com/facebook/rocksdb), [secp256k1](https://github.com/bitcoin-core/secp256k1), [ethash](https://github.com/ethereum/ethash) and [snappy](https://github.com/google/snappy).
 
-It's recommendation to [setup with docker](#setup-with-docker), it will save lots of time.
+It's a recommendation to [setup with docker](#setup-with-docker), it will help to save lots of time.
+
+### Setup with docker
+
+Use docker command to pull image:
+
+``` bash
+docker pull ciriethereum/ciri
+```
+
+Or you can use our prepared rake tasks if you're not familiar with docker:
+
+clone repo and submodules
+
+``` bash
+git clone --recursive https://github.com/ciri-ethereum/ciri.git
+cd ciri
+```
+
+make sure we have installed docker, ruby and rake
+``` bash
+# make sure we have installed docker, ruby and rake
+docker -v
+gem install rake
+```
+
+#### Pull docker image
+
+``` bash
+# pull Ciri docker image
+rake docker:pull
+```
+
+#### Build docker image
+(it will take a few minutes)
+``` bash
+# build Ciri docker image
+rake docker:build
+```
+
+#### Run tests in docker
+``` bash
+# run tests
+rake docker:quick
+```
+
+#### Other usages
+``` bash
+# open a shell for developing
+rake docker:shell
 
+# type 'rake -T' see other supported tasks 
+rake -T
+``` 
 
 ### Manually Setup
 
@@ -40,7 +87,7 @@ git clone --recursive https://github.com/ciri-ethereum/ciri.git
 
 #### Install dependencies
 
-On mac you can install `rocksdb` and `snappy` with homebrew
+On a mac you can install `rocksdb` and `snappy` with homebrew
 
 ``` bash
 brew install rocksdb snappy
@@ -58,7 +105,7 @@ secp256k1
 cd secp256k1 && ./autogen.sh && ./configure --enable-module-recovery --enable-experimental --enable-module-ecdh && make && make install
 ```
 
-For linux user, remember check [Dockerfile](/docker) instructions for hint.
+For linux users, remember to check [Dockerfile](/docker) instructions for hint.
 
 then run: 
 ``` bash
@@ -67,49 +114,22 @@ bundle install
 
 run tests:
 ``` bash
-RUBY_THREAD_VM_STACK_SIZE=52428800 bundle exec rake test
+RUBY_THREAD_VM_STACK_SIZE=52428800 bundle exec rake quick
 ```
 
+Why Ruby?
+---------------
 
-### Setup with docker
+> Because Ruby has built-in block support!
 
-It's recommendation to use docker to handle dependencies:
+Seriously, 
 
-make sure we have installed docker, ruby and rake
-``` bash
-# make sure we have installed docker, ruby and rake
-docker -v
-gem install rake
-```
+Ruby is a scripting language which makes it easy to write prototype or research code (like the official python Ethereum implementation intended).
 
-#### Pull docker image
-pull latest released Ciri docker image
-``` bash
-# pull Ciri docker image
-rake docker:pull
-```
-
-#### Build docker image
-build local docker image (it will take few minutes)
-``` bash
-# build Ciri docker image
-rake docker:build
-```
+According to the several performance research projects in Ruby community (JIT, JRuby, TruffleRuby), we are highly looking forward to seeing improvement of this language performance in the future. 
 
-#### Run tests in docker
-``` bash
-# run tests
-rake docker:test
-```
+Due to Ruby, we could expect to achieve both research-friendly and high-performance in our implementation.
 
-#### Other usage
-``` bash
-# open a shell for develop
-rake docker:shell
-
-# cool, type 'rake -T' see other supported tasks 
-rake -T
-``` 
 
 Contributors
 ---------------

data/Rakefile

@@ -14,8 +14,8 @@ end
 
 SUB_COMPONENTS = %w{ciri-utils ciri-rlp ciri-crypto}
 
-desc 'run tests'
-task :test do
+desc 'run quick spec'
+task :quick do
   exit(1) unless check_env
   run("rspec -t ~slow_tests")
   SUB_COMPONENTS.each do |dir|
@@ -23,8 +23,8 @@ task :test do
   end
 end
 
-desc 'run all tests, include extreme slow tests'
-task :"test:all" do
+desc 'run all specs, include extreme slow tests'
+task :"spec:all" do
   exit(1) unless check_env
   run("rspec")
   SUB_COMPONENTS.each do |dir|
@@ -33,7 +33,7 @@ task :"test:all" do
 end
 
 namespace :docker do
-  base_image = 'ciriethereum/base'
+  base_image = 'ciriethereum/ciri'
 
   desc 'pull docker image'
   task :pull do
@@ -46,6 +46,11 @@ namespace :docker do
     run("docker build . -f docker/Dockerfile -t #{base_image}:latest")
   end
 
+  desc 'push docker image'
+  task :push do
+    run("docker push #{base_image}:latest")
+  end
+
   desc 'open Ciri develop container shell'
   task :shell do
     container_name = 'ciri-develop'
@@ -57,14 +62,14 @@ namespace :docker do
     end
   end
 
-  desc 'run tests in docker'
-  task :test do
-    run("docker run -v `pwd`:/app --rm #{base_image}:latest rake test")
+  desc 'run quick specs in docker'
+  task :quick do
+    run("docker run -v `pwd`:/app --rm #{base_image}:latest rake quick")
   end
 
-  desc 'run all tests(include slow tests) in docker'
-  task :"test:all" do
-    run("docker run -v `pwd`:/app --rm #{base_image}:latest rake test:all")
+  desc 'run all specs(include slow tests) in docker'
+  task :"spec:all" do
+    run("docker run -v `pwd`:/app --rm #{base_image}:latest rake spec:all")
   end
 
   private

data/ciri-crypto/lib/ciri/crypto/signature.rb

@@ -50,20 +50,22 @@ module Ciri
 
       def signature
         @signature ||= Utils.big_endian_encode(@r, "\x00".b, size: 32) +
-          Utils.big_endian_encode(@s, "\x00".b, size: 32) +
-          Utils.big_endian_encode(@v, "\x00".b)
+            Utils.big_endian_encode(@s, "\x00".b, size: 32) +
+            Utils.big_endian_encode(@v, "\x00".b)
       end
 
       alias to_s signature
 
       def valid?
         v <= 1 &&
-          r < SECP256K1N && r >= 1 &&
-          s < SECP256K1N && s >= 1
+            r < SECP256K1N && r >= 1 &&
+            s < SECP256K1N && s >= 1
       end
 
+      # high s value is invalid after Homestead fork
+      # see https://github.com/ethereum/EIPs/blob/master/EIPS/eip-2.md#specification
       def low_s?
-        s < (SECP256K1N / 2)
+        s <= (SECP256K1N / 2)
       end
     end
 

data/ciri-rlp/ciri-rlp.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "ciri-utils", "~> 0.2.0"
+  spec.add_dependency "ciri-utils", "~> 0.2.1"
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 12.0"
   spec.add_development_dependency "rspec", "~> 3.0"

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

@@ -22,7 +22,7 @@ require_relative 'rlp/serializable'
 module Ciri
   module RLP
 
-    class InvalidValueError < StandardError
+    class InvalidError < StandardError
     end
 
     extend Encode

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

@@ -44,7 +44,7 @@ module Ciri
         if type == Integer
           item = s.read(1)
           if item.nil?
-            raise InvalidValueError.new "invalid bool value nil"
+            raise InvalidError.new "invalid bool value nil"
           elsif item == "\x80".b || item.empty?
             0
           elsif item.ord < 0x80
@@ -60,7 +60,7 @@ module Ciri
           elsif item == Bool::ENCODED_FALSE
             false
           else
-            raise InvalidValueError.new "invalid bool value #{item}"
+            raise InvalidError.new "invalid bool value #{item}"
           end
         elsif type.is_a?(Class) && type.respond_to?(:rlp_decode)
           type.rlp_decode(s)
@@ -73,10 +73,18 @@ module Ciri
               i += 1
             end
           end
+        elsif type == RawString
+          str = decode_stream(s)
+          raise RLP::InvalidError.new "decode #{str.class} from RawString" unless str.is_a?(String)
+          str
+        elsif type == RawList
+          list = decode_stream(s)
+          raise RLP::InvalidError.new "decode #{list.class} from RawList" unless list.is_a?(Array)
+          list
         elsif type == Raw
           decode_stream(s)
         else
-          raise RLP::InvalidValueError.new "unknown type #{type}"
+          raise RLP::InvalidError.new "unknown type #{type}"
         end
       rescue
         STDERR.puts "when decoding #{s} into #{type}"
@@ -89,7 +97,6 @@ module Ciri
         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
@@ -97,11 +104,13 @@ module Ciri
                 when 0xf8..0xff
                   length_binary = s.read(c.ord - 0xf7)
                   length = int_from_binary(length_binary)
-                  s.read(length)
+                  check_range_and_read(s, length)
                 else
-                  raise InvalidValueError.new("invalid char #{c}")
+                  raise InvalidError.new("invalid char #{c}")
                 end
 
+        raise InvalidError.new("stream EOF when encode_list") unless sub_s
+
         decoder.call(list, StringIO.new(sub_s))
         list
       end
@@ -110,6 +119,7 @@ module Ciri
 
       def decode_stream(s)
         c = s.read(1)
+        raise InvalidError.new("read none char from stream") unless c
         case c.ord
         when 0x00..0x7f
           c
@@ -119,7 +129,7 @@ module Ciri
         when 0xb8..0xbf
           length_binary = s.read(c.ord - 0xb7)
           length = int_from_binary(length_binary)
-          s.read(length)
+          check_range_and_read(s, length)
         else
           decode_list(s, c) do |list, s2|
             until s2.eof?
@@ -129,6 +139,12 @@ module Ciri
         end
       end
 
+      def check_range_and_read(s, length)
+        s.read(length)
+      rescue RangeError
+        raise InvalidError.new("length too long: #{length}")
+      end
+
       def int_from_binary(input)
         Ciri::Utils.big_endian_decode(input)
       end

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

@@ -70,12 +70,18 @@ module Ciri
           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}"
+            raise RLP::InvalidError.new "type size should be 1, got #{type}"
           end
         elsif type == Raw
           encode_raw(item)
+        elsif type == RawString
+          raise RLP::InvalidError.new "expect String, got #{item.class}" unless item.is_a?(String)
+          encode_raw(item)
+        elsif type == RawList
+          raise RLP::InvalidError.new "expect Array, got #{item.class}" unless item.is_a?(Array)
+          encode_raw(item)
         else
-          raise RLP::InvalidValueError.new "unknown type #{type}"
+          raise RLP::InvalidError.new "unknown type #{type}"
         end
       rescue
         STDERR.puts "when encoding #{Utils.to_hex item.to_s} into #{type}"

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

@@ -30,6 +30,12 @@ module Ciri
     class Raw
     end
 
+    class RawString
+    end
+
+    class RawList
+    end
+
     # Serializable module allow ruby objects serialize/deserialize to or from RLP encoding.
     # See Ciri::RLP::Serializable::TYPES for supported type.
     #
@@ -69,7 +75,7 @@ module Ciri
     #
     module Serializable
       # nil represent RLP raw value(string or array of string)
-      TYPES = [Raw, Integer, Bool].map {|key| [key, true]}.to_h.freeze
+      TYPES = [Raw, RawString, RawList, Integer, Bool].map {|key| [key, true]}.to_h.freeze
 
       # Schema specific columns types of classes, normally you should not use Serializable::Schema directly
       #
@@ -176,9 +182,13 @@ module Ciri
         end
 
         def schema(data_schema = nil)
-          @data_schema ||= Schema.new(data_schema).tap do |schema|
-            # define attributes methods
-            define_attributes(schema)
+          if data_schema
+            @data_schema = Schema.new(data_schema).tap do |schema|
+              # define attributes methods
+              define_attributes(schema)
+            end
+          else
+            @data_schema ||= superclass.schema
           end
         end