Ciri::P2P
P2P network implementation for Ciri Ethereum.
ciri-p2p
is a DevP2P implementation, we also seek to implement LibP2P components upon ciri-p2p codebase in the future.
Installation
Install dependencies
Ciri P2P depend on secp256k1
to handle crypto signature and depend on snappy
to compress data.
Build and install secp256k1
cd ciri
git submodule init && git submodule update
rake install:secp256k1
On Mac you can install snappy
with homebrew
brew install snappy
For linux users, remember to check Dockerfile instructions for hint.
then run tests:
bundle exec rake spec
Install as Gem
Add this line to your application's Gemfile:
gem 'ciri-p2p'
And then execute:
$ bundle
Or install it yourself as:
$ gem install ciri-p2p
Usage
Check spec directory, especially server_spec.rb.
Examples
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.
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/ciri-ethereum/ciri-p2p. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
License
The gem is available as open source under the terms of the MIT License.
Code of Conduct
Everyone interacting in the Ciri::P2p project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.