a straightforward library to build, sign, and broadcast ethereum transactions anywhere you can run ruby.
APACHE-2.0 License
A straightforward library to build, sign, and broadcast Ethereum transactions. It allows the separation of key and node management. Sign transactions and handle keys anywhere you can run Ruby and broadcast transactions through any local or remote node. Sign messages and recover signatures for authentication.
What you get:
Add this line to your application's Gemfile:
gem "eth"
Or install it yourself as:
gem install eth
Check out the and the for all the details and example snippets.
The documentation can be found at: https://q9f.github.io/eth.rb
For any specific version, docs can be generated by yard
:
gem install bundler rdoc yard
git checkout $VERSION
yard doc
The goal is to have 100% API documentation available.
The test suite expects working local HTTP and IPC endpoints with a prefunded developer account, e.g.:
geth --dev --http --ipcpath /tmp/geth.ipc &
It also expects an $INFURA_TOKEN
in environment to test some ENS queries on mainnet.
To run tests, simply use rspec
. Note, that the Ethereum test fixtures are also required.
git submodule update --init --recursive
bundle install
rspec
The goal is to have 100% specification coverage for all code inside this gem.
Pull requests are welcome! To contribute, please consider the following:
yard doc
and make sure it does not yield any warnings or undocumented sets.rspec
to make sure all tests pass. The CI has an integration that will assis you to identify uncovered lines of code and get coverage up to 100%.rufo
gem is recommended.The eth
gem is licensed under the conditions of Apache 2.0. Please see AUTHORS for contributors and copyright notices.
This gem is a complete rewrite of the old eth
gem by Steve Ellis.
It is not only a rewrite of the eth
gem but also a partial merge of the ethereum
gem by Marek Kirejczyk and Yuta Kurotaki.
This gem also includes a revised version of the ABI gem by Jan Xie and Zhang Yaning.
It also contains a condensed version of the RLP gem by Jan Xie and Zhang Yaning.