ciri 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0fb4f5d7ae9d525c598590327ea9652617ca2d48eff3edd40c36307d9b140fbf
-  data.tar.gz: d45c159bc70ba765cae8d6b4150e3088ad8e43f55ec7e3f4cf691152604aa8ce
+  metadata.gz: abe8d78482df9ed72840456def4146338c14d14fe797d8a97ff8bbe1a93f1243
+  data.tar.gz: 65f245e4ec4aa14c2747745976a350ceee764c08f8e010e6586e6c8ba5a57227
 SHA512:
-  metadata.gz: 35f02c14a3401ab6bbcfae9617ce1b4872a71e9117b05d5ac99e5795c2027d7a8c7e448cce617b25a120cc3da7ecda24eea6fe7ea91689d88457840c0b2fc41b
-  data.tar.gz: d1867a3cc573020f8e5b1466d701029646598c748f1fdc405f34123120b77035ff369c9a6b92fa29e08072d1f5de9bc738f756c8071e24929afbc6f5868b2af1
+  metadata.gz: 478a4f654e958caa242c46881120d7737a7b74a72f142a05e29ea83fa32daef22d0a63832f9fc4ef649c9a8860e3be5226a376304d52de78ac1ec1e9ad1005b2
+  data.tar.gz: 556717e91e6dd17e22aeadd6c9f322ffd7d95540bbfcb9bfa775acdafa63a31e149bba971dd4e03ea935eba24d5f3a4f77bde2ba52c0bbe2e2f32b872c86afad

data/.gitmodules

@@ -0,0 +1,14 @@
+[submodule "secp256k1"]
+	path = secp256k1
+	url = https://github.com/bitcoin-core/secp256k1.git
+[submodule "rocksdb"]
+	path = rocksdb
+	url = https://github.com/facebook/rocksdb.git
+[submodule "ethash"]
+	path = ethash
+	url = https://github.com/ciri-ethereum/ethash.git
+	branch = shared_library
+[submodule "fixtures"]
+	path = fixtures
+	url = https://github.com/ethereum/tests.git
+	branch = develop

data/.rspec

@@ -1,3 +1,4 @@
---format documentation
+--format progress
 --color
 --require spec_helper
+--profile

data/.travis.yml

@@ -1,5 +1,12 @@
-sudo: false
+sudo: required
 language: ruby
-rvm:
-  - 2.5.0
-before_install: gem install bundler -v 1.16.1
+
+services:
+  - docker
+
+before_install:
+  - docker pull ciriethereum/base:latest
+  - gem install rake
+
+script:
+  - rake docker:test

data/Gemfile.lock

@@ -5,6 +5,8 @@ PATH
       bitcoin-secp256k1 (~> 0.4.0)
       concurrent-ruby (~> 1.0.5)
       digest-sha3 (~> 1.1.0)
+      ffi (~> 1.9.23)
+      lru_redux (~> 1.1.0)
       snappy (~> 0.0.17)
 
 GEM
@@ -16,6 +18,7 @@ GEM
     diff-lcs (1.3)
     digest-sha3 (1.1.0)
     ffi (1.9.23)
+    lru_redux (1.1.0)
     rake (10.3.2)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)

data/README.md

@@ -1,49 +1,59 @@
 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 project intent to implement a full feature set ethereum client.
 
-### Check List
-
-* [ ] RLPX
-  * [x] HandShake
-  * [ ] Server
-  * [ ] Node Discovery
-* [x] RLP
-* [ ] Eth Protocol
-  * [x] HandShake
-  * [ ] Ethereum Sub-protocol
-* [ ] Block Chain
-  * [ ] Chain Syncing
-  * [ ] EVM
-  * [ ] Mining
-* [ ] Consensus Algorithm
-  * [ ] POW
-  * [ ] POS
-* [ ] Web3 RPC
-* [ ] CLI
-
-### Install
+It aims to be a feature complete, long maintained and stable ethereum client.
+As you see it'is still under development.
 
-``` bash
-gem install ciri
-```
+Talk to me on [gitter](https://gitter.im/ciri-ethereum/Lobby) if you interesting in this project or want to contributing.
+
+See [projects](https://github.com/ciri-ethereum/ciri/projects) and [milestones](https://github.com/ciri-ethereum/ciri/milestones) for current development status.
 
-As library
+Installation
+---------------
 
-``` ruby
-require 'ciri'
-puts Ciri::Version
-```
+See [develop](#develop) section
 
-### Command line
+Usage
+---------------
 
 `ciri -h`
 
-### Documentation
+Develop
+---------------
+
+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 recommended to use docker to handle dependencies:
+``` bash
+# make sure we have installed docker, ruby and rake
+docker -v
+gem install rake
+
+# pull Ciri base image
+rake docker:pull_base
+# run tests
+rake docker:test
+# open a shell for develop
+rake docker:shell
+
+# cool, type 'rake -T' see other supported tasks 
+``` 
+ 
+Otherwise you need install these libraries manually (remember check [docker](/docker) directory for hint).
+
+then run: 
+`bundle install && bundle exec rake`
+
+Documentation
+---------------
 
-[YARD documentation](https://www.rubydoc.info/github/ruby-ethereum/ciri/master)
+[YARD documentation](https://www.rubydoc.info/github/ciri-ethereum/ciri/master)
 
-### Author
+Authors
+---------------
 
-[Jiang Jinyang](https://justjjy.com)
+* [Jiang Jinyang](https://justjjy.com) (jjyruby@gmail.com)

data/Rakefile

@@ -1,6 +1,49 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+begin
+  require "bundler/gem_tasks"
+rescue LoadError
+  puts "bundler not installed, use 'gem install bundler' to install"
+end
 
-RSpec::Core::RakeTask.new(:spec)
+begin
+  require "rspec/core/rake_task"
+  RSpec::Core::RakeTask.new(:spec)
+  task :default => :spec
+rescue LoadError
+  nil
+end
 
-task :default => :spec
+namespace :docker do
+  base_image = 'ciriethereum/base'
+
+  desc 'pull base docker image'
+  task :pull_base do
+    system("docker pull #{base_image}:latest")
+  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")
+  end
+
+  desc 'open Ciri develop container shell'
+  task :shell do
+    container_name = 'ciri-develop'
+    if system("docker inspect #{container_name} > /dev/null")
+      system("docker start -i #{container_name}")
+    else
+      puts "start a new develop container: #{container_name}"
+      system("docker run -v `pwd`:/app -it --name #{container_name} #{base_image}:latest bash")
+    end
+  end
+
+  desc 'run tests in docker'
+  task :test do
+    system("docker run -v `pwd`:/app --rm #{base_image}:latest rspec -t ~slow_tests")
+  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")
+  end
+end

data/ciri.gemspec

@@ -1,26 +1,27 @@
-
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "ciri/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "ciri"
-  spec.version       = Ciri::VERSION
-  spec.authors       = ["Jiang Jinyang"]
-  spec.email         = ["jjyruby@gmail.com"]
+  spec.name = "ciri"
+  spec.version = Ciri::VERSION
+  spec.authors = ["Jiang Jinyang"]
+  spec.email = ["jjyruby@gmail.com"]
 
-  spec.summary       = %q{Ruby implementation of the ethereum}
-  spec.description   = %q{Ciri project intent to implement full feature set of ethereum in pure ruby, to provide both usable cli and well documented ruby library.}
-  spec.homepage      = "https://github.com/ruby-ethereum/ethereum"
-  spec.license       = "MIT"
+  spec.summary = %q{Ciri ethereum client.}
+  spec.description = %q{Ciri project intent to implement a full feature set ethereum client.}
+  spec.homepage = "https://github.com/ciri-ethereum/ciri"
+  spec.license = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  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.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) {|f| File.basename(f)}
   spec.require_paths = ["lib"]
 
+  spec.add_dependency 'ffi', '~> 1.9.23'
+  spec.add_dependency 'lru_redux', '~> 1.1.0'
   spec.add_dependency 'digest-sha3', '~> 1.1.0'
   spec.add_dependency 'bitcoin-secp256k1', '~> 0.4.0'
   spec.add_dependency 'concurrent-ruby', '~> 1.0.5'

data/docker/Base

@@ -0,0 +1,34 @@
+FROM ruby:2.5.1
+MAINTAINER Jiang Jinyang<jjyruby@gmail.com>
+
+RUN apt-get update -y
+RUN apt-get install -y cmake
+
+# install bitcoin secp256k1
+COPY ./secp256k1 /build/secp256k1
+WORKDIR /build/secp256k1
+RUN ./autogen.sh
+RUN ./configure --enable-module-recovery --enable-experimental --enable-module-ecdh
+RUN make && make install
+
+# install ethash
+COPY ./ethash /build/ethash
+WORKDIR /build/ethash/src/libethash
+RUN cmake CMakeLists.txt
+RUN make install
+
+# install RocksDB
+RUN apt-get install -y libgflags-dev zlib1g-dev libbz2-dev liblz4-dev libzstd-dev
+COPY ./rocksdb /build/rocksdb
+WORKDIR /build/rocksdb
+RUN make shared_lib
+RUN make install-shared
+
+# install snappy
+RUN apt-get install -y libsnappy-dev
+
+WORKDIR /app
+COPY . /app
+
+# bundle
+RUN bundle install

data/lib/ciri/actor.rb

@@ -0,0 +1,223 @@
+# 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 'logger'
+
+module Ciri
+
+  # simple actor model implementation
+  # Example:
+  #
+  #   class Hello
+  #     include Actor
+  #
+  #     def say_hello
+  #       puts 'hello world'
+  #       'hello world'
+  #     end
+  #   end
+  #
+  #   actor = Hello.new()
+  #   # start actor loop
+  #   actor.start
+  #   # push message to actor inbox
+  #   actor << :say_hello
+  #   # push message and wait until get response
+  #   actor.call(:say_hello).value
+  #
+  #   # raise error
+  #   actor.call(:hello).value # NoMethodError
+  #
+  #   # stop actor
+  #   actor.send_stop
+  #   actor.wait
+  #
+  module Actor
+
+    LOGGER = Logger.new(STDERR, datetime_format: '%Y-%m-%d %H:%M:%S', level: Logger::INFO)
+
+    # future, use this to wait actor msg respond
+    class Future
+      def initialize
+        @value = nil
+        @done = false
+        @queue = Queue.new
+      end
+
+      def value=(val)
+        if @done
+          raise RuntimeError.new('future value duplicated set')
+        end
+        @done = true
+        @queue << :done if @queue
+        @value = val
+      end
+
+      def value
+        loop do
+          if @done
+            return @value
+          elsif @error
+            raise @error
+          else
+            @queue.pop
+          end
+        end
+      end
+
+      def raise_error(error)
+        error.set_backtrace(caller) if error.backtrace.nil?
+        @error = error
+        @queue << :error if @queue
+      end
+    end
+
+    class Error < StandardError
+    end
+
+    # stop actor
+    class StopError < Error
+    end
+
+    class StateError < Error
+    end
+
+    class << self
+      attr_accessor :default_executor
+    end
+
+    attr_accessor :executor
+
+    def initialize(executor: Actor.default_executor)
+      @inbox = Queue.new
+      @executor = executor
+      @future = Future.new
+      @running = false
+    end
+
+    # async call
+    def enqueue(method, *args)
+      self << [method, *args]
+    end
+
+    def <<(args)
+      @inbox << args
+    end
+
+    # sync call, push msg to inbox, and return future
+    #
+    # Example:
+    #   future = actor.call(:result) # future
+    #   future.value # blocking and wait for result
+    #
+    def call(method, *args)
+      future = Future.new
+      self << [future, method, *args]
+      future
+    end
+
+    # start actor
+    def start
+      raise Error.new("must set executor before start") unless executor
+
+      @running = true
+      executor.post do
+        start_loop
+      end
+    end
+
+    # send stop to actor
+    #
+    # Example:
+    #   actor.send_stop
+    #   # wait for actor actually stopped
+    #   actor.wait
+    #
+    def send_stop
+      self << [:raise_error, StopError.new]
+    end
+
+    # wait until an error occurs
+    def wait
+      raise StateError.new('actor not running!') unless @running
+      @future.value
+    end
+
+    # start loop
+    def start_loop
+      loop_callback do |wait_message: true|
+        # check inbox
+        next Thread.pass if @inbox.empty? && !wait_message
+        msg = @inbox.pop
+
+        # extract sync or async call
+        future = nil
+        method, *args = msg
+        if method.is_a?(Future)
+          future = method
+          method, *args = args
+        end
+        begin
+          val = send(method, *args)
+        rescue StandardError => e
+          future.raise_error(e) if future
+          raise
+        end
+        # if future not nil, set value
+        future.value = val if future
+      end until @inbox.closed?
+
+    rescue StopError
+      # actor stop
+      @future.value = nil
+    rescue StandardError => e
+      @future.raise_error e
+      LOGGER.error("Actor #{self}") {"#{e}\n#{e.backtrace.join("\n")}"}
+    ensure
+      @running = false
+      @inbox.close
+    end
+
+    # allow inject callback into actor loop
+    # Example:
+    #
+    #   class A
+    #     include Actor
+    #
+    #     def loop_callback
+    #       # before handle msg
+    #       yield
+    #       # after handle msg
+    #     end
+    #   end
+    #
+    def loop_callback
+      yield
+    end
+
+    def raise_error(e)
+      raise e
+    end
+  end
+
+end