What is Ciri?
Ciri is an ongoing Ethereum implementation written in Ruby. Ciri aims to become a researcher-friendly Ethereum implementation and a blockchain toolbox for all developers to modify or build their own private/public chains more conveniently in Ruby.
The goals of Ciri:
- Be a researcher-friendly Ethereum implementation, which means Ciri needs to be intelligible and easy to be modified.
- Be a blockchain toolbox, provide components and low-level API for developers to build their own private or public chain.
- In general, we want Ciri to build a bridge to bring rubyist into Ethereum world!
Where will this project go?
Ciri has already passed the Ethereum tests suite and the Ethereum 1.0 POW Chain is almost implemented. However, we still need to implement several components(DevP2P, KeyStore, CLI ...) to support running a fully functionally Ethereum node on the mainnet.
At the same time, we are keeping an eye on Ethereum 2.0 specs: the shasper(sharding + casper) implementation, and pursuing to implement the lastest updated shasper specs.
See our Roadmap on Wiki.
Ciri is still under active development and the master branch is really recommended.
Add this line to your Gemfile:
gem 'ciri', github: 'ciri-ethereum/ciri'
It's a recommendation to setup with docker because it will help to save lots of time.
Setup with docker
Use docker command to pull image:
docker pull ciriethereum/ciri
Or you can use our prepared rake tasks if you're not familiar with docker:
clone repo and submodules
git clone --recursive https://github.com/ciri-ethereum/ciri.git cd ciri
make sure we have installed docker, ruby and rake
# make sure we have installed docker, ruby and rake docker -v gem install rake
Pull docker image
# pull Ciri docker image rake docker:pull
Run tests in docker
# run tests rake docker:spec # run specific component related tests rake docker:spec[component_name]
# open a shell for developing rake docker:shell # build Ciri docker image from current source (it will take a few minutes) rake docker:build # type 'rake -T' see other supported tasks rake -T
clone repo and submodules
git clone --recursive https://github.com/ciri-ethereum/ciri.git
On a mac you can install
snappy with homebrew
brew install rocksdb snappy
Build and install
cd ciri && rake install:secp256k1
For linux users, remember to check Dockerfile instructions for hint.
# run all tests RUBY_THREAD_VM_STACK_SIZE=52428800 bundle exec rake spec # run specific component related tests bundle exec rake spec[component_name]
Because Ruby has built-in block support!
Ruby is a scripting language which makes it easy to write prototype or research code (like the official python Ethereum implementation intended).
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.
Due to Ruby, we could expect to achieve both research-friendly and high-performance in our implementation.