Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/q9f/eth.rb
a straightforward library to build, sign, and broadcast ethereum transactions anywhere you can run ruby.
https://github.com/q9f/eth.rb
abi eip155 eip1559 eip191 eip55 eip712 ethereum rlp ruby secp256k1 solidity transaction
Last synced: 16 days ago
JSON representation
a straightforward library to build, sign, and broadcast ethereum transactions anywhere you can run ruby.
- Host: GitHub
- URL: https://github.com/q9f/eth.rb
- Owner: q9f
- License: apache-2.0
- Created: 2021-11-29T14:49:11.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-01T18:55:27.000Z (about 1 month ago)
- Last Synced: 2024-10-04T10:37:36.763Z (about 1 month ago)
- Topics: abi, eip155, eip1559, eip191, eip55, eip712, ethereum, rlp, ruby, secp256k1, solidity, transaction
- Language: Ruby
- Homepage: https://q9f.github.io/eth.rb
- Size: 3.2 MB
- Stars: 201
- Watchers: 11
- Forks: 87
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
- Authors: AUTHORS.txt
Awesome Lists containing this project
README
# Ethereum for Ruby
[](https://github.com/q9f/eth.rb/actions)
[](https://github.com/q9f/eth.rb/releases)
[](https://rubygems.org/gems/eth)
[](https://rubygems.org/gems/eth)
[](https://hits.seeyoufarm.com)
[](https://codecov.io/gh/q9f/eth.rb)
[](https://codeclimate.com/github/q9f/eth.rb/maintainability)
[](https://github.com/q9f/eth.rb/pulse)
[](https://q9f.github.io/eth.rb)
[](https://github.com/q9f/eth.rb/wiki)
[](LICENSE)
[](https://github.com/q9f/eth.rb/issues)
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:
- [x] Secp256k1 Key-Pairs and Encrypted Ethereum Key-Stores (JSON)
- [x] EIP-20 Token Transfers (ERC20)
- [x] EIP-55 Checksummed Ethereum Addresses
- [x] EIP-137 Ethereum Domain Name Service (ENS)
- [x] EIP-155 Replay protection with Chain IDs (with presets)
- [x] EIP-191 Ethereum Signed Messages (with prefix and type)
- [x] EIP-712 Ethereum Signed Type Data
- [x] EIP-1271 Smart-Contract Authentification
- [x] EIP-1559 Ethereum Type-2 Transactions (with priority fee and max gas fee)
- [x] EIP-2028 Call-data intrinsic gas cost estimates (plus access lists)
- [x] EIP-2718 Ethereum Transaction Envelopes (and types)
- [x] EIP-2930 Ethereum Type-1 Transactions (with access lists)
- [x] ABI-Encoder and Decoder (including type parser)
- [x] RLP-Encoder and Decoder (including sedes)
- [x] RPC-Client (IPC/HTTP) for Execution-Layer APIs
- [x] Solidity bindings (compile contracts from Ruby)
- [x] Full smart-contract support (deploy, transact, and call)
## Installation
Add this line to your application's Gemfile:
```ruby
gem "eth"
```
Or install it yourself as:
```shell
gem install eth
```
## Usage
Check out the
[](https://q9f.github.io/eth.rb)
and the
[](https://github.com/q9f/eth.rb/wiki)
for all the details and example snippets.
## Documentation
The documentation can be found at: https://q9f.github.io/eth.rb
For any specific version, docs can be generated by `yard`:
```shell
gem install bundler rdoc yard
git checkout $VERSION
yard doc
```
The goal is to have 100% API documentation available.
## Testing
The test suite expects working local HTTP and IPC endpoints with a prefunded developer account, e.g.:
```shell
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.
```shell
git submodule update --init --recursive
bundle install
rspec
```
The goal is to have 100% specification coverage for all code inside this gem.
## Contributing
Pull requests are welcome! To contribute, please consider the following:
* Code should be fully documented. Run `yard doc` and make sure it does not yield any warnings or undocumented sets.
* Code should be fully covered by tests. Run `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%.
* Code should be formatted properly. Try to eliminate the most common issues such as trailing white-spaces or duplicate new-lines. Usage of the `rufo` gem is recommended.
* Submit pull requests, questions, or issues to Github:
## License and Credits
The `eth` gem is licensed under the conditions of [Apache 2.0](./LICENSE.txt). Please see [AUTHORS](./AUTHORS.txt) for contributors and copyright notices.
This gem is a complete rewrite of the old `eth` gem by Steve Ellis.
* (MIT)
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.
* (MIT)
This gem also includes a revised version of the ABI gem by Jan Xie and Zhang Yaning.
* (MIT)
It also contains a condensed version of the RLP gem by Jan Xie and Zhang Yaning.
* (MIT)