eth 0.4.18 → 0.5.2

data/README.md

@@ -1,151 +1,306 @@
-# Eth for Ruby
-[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/se3000/ruby-eth/Build)](https://github.com/se3000/ruby-eth/actions)
-[![GitHub release (latest by date)](https://img.shields.io/github/v/release/se3000/ruby-eth)](https://github.com/se3000/ruby-eth/releases)
+# Ethereum for Ruby
+
+[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/q9f/eth.rb/Spec)](https://github.com/q9f/eth.rb/actions)
+[![GitHub release (latest by date)](https://img.shields.io/github/v/release/q9f/eth.rb)](https://github.com/q9f/eth.rb/releases)
 [![Gem](https://img.shields.io/gem/v/eth)](https://rubygems.org/gems/eth)
 [![Gem](https://img.shields.io/gem/dt/eth)](https://rubygems.org/gems/eth)
-[![GitHub top language](https://img.shields.io/github/languages/top/se3000/ruby-eth?color=red)](https://github.com/se3000/ruby-eth/pulse)
-[![GitHub](https://img.shields.io/github/license/se3000/ruby-eth)](LICENSE)
-
-A simple library to build and sign Ethereum transactions. Allows separation of key and node management. Sign transactions and handle keys anywhere you can run ruby, broadcast transactions through any node.
-
-## Installation
-
+[![Visitors](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2Fq9f%2Feth.rb&count_bg=%2379C83D&title_bg=%23555555&icon=rubygems.svg&icon_color=%23FF0000&title=visitors&edge_flat=false)](https://hits.seeyoufarm.com)
+[![codecov](https://codecov.io/gh/q9f/eth.rb/branch/main/graph/badge.svg?token=IK7USBPBZY)](https://codecov.io/gh/q9f/eth.rb)
+[![Maintainability](https://api.codeclimate.com/v1/badges/469e6f66425198ad7614/maintainability)](https://codeclimate.com/github/q9f/eth.rb/maintainability)
+[![Top Language](https://img.shields.io/github/languages/top/q9f/eth.rb?color=red)](https://github.com/q9f/eth.rb/pulse)
+[![Yard Doc API](https://img.shields.io/badge/documentation-API-blue)](https://q9f.github.io/eth.rb)
+[![Usage Wiki](https://img.shields.io/badge/usage-WIKI-blue)](https://github.com/q9f/eth.rb/wiki)
+[![Open-Source License](https://img.shields.io/github/license/q9f/eth.rb)](LICENSE)
+[![Contributions Welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](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-55 Checksummed Ethereum Addresses
+- [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-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)
+
+Soon (TM):
+- [ ] Smart Contract Support
+- [ ] EIP-1271 Smart-Contract Authentification
+- [ ] HD-Wallets (BIP-32) and Mnemonics (BIP-39)
+
+Contents:
+- [1. Installation](#1-installation)
+- [2. Usage](#2-usage)
+  - [2.1. Ethereum Keys and Addresses (EIP-55)](#21-ethereum-keys-and-addresses-eip-55)
+  - [2.2. Ethereum Signatures (EIP-191, EIP-712)](#22-ethereum-signatures-eip-191-eip-712)
+  - [2.3. Ethereum Chains (EIP-155)](#23-ethereum-chains-eip-155)
+  - [2.4. Ethereum Transactions (EIP-1559, EIP-2718, EIP-2930)](#24-ethereum-transactions-eip-1559-eip-2718-eip-2930)
+  - [2.5. Ethereum ABI Encoder and Decoder](#25-ethereum-abi-encoder-and-decoder)
+  - [2.6. Ethereum RLP Encoder and Decoder](#26-ethereum-rlp-encoder-and-decoder)
+  - [2.7. Ethereum RPC-Client](#27-ethereum-rpc-client)
+  - [2.8 Solidity Compiler Bindings](#28-solidity-compiler-bindings)
+- [3. Documentation](#3-documentation)
+- [4. Testing](#4-testing)
+- [5. Contributing](#5-contributing)
+- [6. License and Credits](#6-license-and-credits)
+
+## 1. Installation
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'eth'
+gem "eth"
 ```
 
-And then execute:
-
-    $ bundle install
-
 Or install it yourself as:
 
-    $ gem install eth
-
-## Usage
+```shell
+gem install eth
+```
 
-### Keys
+## 2. Usage
+Check out
+[![Yard Doc API](https://img.shields.io/badge/documentation-API-blue)](https://q9f.github.io/eth.rb)
+and
+[![Usage Wiki](https://img.shields.io/badge/usage-WIKI-blue)](https://github.com/q9f/eth.rb/wiki)
+for full details.
 
-Create a new public/private key and get its address:
+### 2.1. Ethereum Keys and Addresses (EIP-55)
+Generate a random Secp256k1 key-pair.
 
 ```ruby
 key = Eth::Key.new
-key.private_hex
-key.public_hex
-key.address # EIP55 checksummed address
+# => #<Eth::Key:0x00005574a6ba80b8 @private_key=#<Secp256k1::PrivateKey:0x00005574a6b9a0a8 @data=")&\x86P\xB5\x16\xD9]\xFA;\x1F\xF6\xD9\xCF\xE3Vj/\xE2\x81\xC0\x9D\xE9\x05o!q\x82G\x9A\x10Q">, @public_key=#<Secp256k1::PublicKey:0x00005574a6b9bf98>>
 ```
 
-Import an existing key:
+Create an password-encrypted Ethereum key-store.
 
 ```ruby
-old_key = Eth::Key.new priv: private_key
+my_key = Eth::Key.new priv: "30137644b564785d01420f8043f043d74dcca64008e57c59f8ce713a0005a54b"
+key_store = Eth::Key::Encrypter.perform my_key, "secret-password-1337"
+# => "{\"crypto\":{\"cipher\":\"aes-128-ctr\",\"cipherparams\":{\"iv\":\"7e5c0fe1e27f4ea61b0f4427dd63555f\"},\"ciphertext\":\"6353653bba494cdae6bcd510febc980cdc6f7b23cfbdf950d7a909a69625c8fd\",\"kdf\":\"pbkdf2\",\"kdfparams\":{\"c\":262144,\"dklen\":32,\"prf\":\"hmac-sha256\",\"salt\":\"cce96286f3c32267fc91f756365307fe6a4c83b6b2a73c69535f721fa407736c\"},\"mac\":\"3361ffd2b158a1d7bca5a5fd86a251ba3e9d80b602c867a2e0f47023a0e17a57\"},\"id\":\"642ee9fc-72e4-4d0a-902f-247c0b59bfda\",\"version\":3}"
+restored_key = Eth::Key::Decrypter.perform key_store, "secret-password-1337"
+# => "30137644b564785d01420f8043f043d74dcca64008e57c59f8ce713a0005a54b"
 ```
 
-Or decrypt an [encrypted key](https://github.com/ethereum/wiki/wiki/Web3-Secret-Storage-Definition):
+Manage Ethereum address objects adhering to EIP-55 checksum format.
 
 ```ruby
-decrypted_key = Eth::Key.decrypt File.read('./some/path.json'), 'p455w0rD'
+address = Eth::Address.new "0xd496b23d61f88a8c7758fca7560dcfac7b3b01f9"
+# => #<Eth::Address:0x00005574a6bd4fc8 @address="0xd496b23d61f88a8c7758fca7560dcfac7b3b01f9">
+address.valid?
+# => true
+address.checksummed # EIP 55
+# => "0xD496b23D61F88A8C7758fca7560dCFac7b3b01F9"
 ```
 
-You can also encrypt your keys for use with other ethereum libraries:
+See `/spec` or [Documentation](https://q9f.github.io/eth.rb/) for more details about key-pairs, encrypting/decrypting key-stores with a secret, and checksummed addresses.
+
+### 2.2. Ethereum Signatures (EIP-191, EIP-712)
+Manage keypairs to sign messages in EIP-191 (`personal_sign`) format or typed data in EIP-712 (`sign_typed_data`) format.
 
 ```ruby
-encrypted_key_info = Eth::Key.encrypt key, 'p455w0rD'
+key = Eth::Key.new priv: "268be6f4a68c40f6862b7ac9aed8f701dc25a95ddb9a44d8b1f520b75f440a9a"
+# => #<Eth::Key:0x00005574a699adc0 @private_key=#<Secp256k1::PrivateKey:0x00005574a6998200 @data="&\x8B\xE6\xF4\xA6\x8C@\xF6\x86+z\xC9\xAE\xD8\xF7\x01\xDC%\xA9]\xDB\x9AD\xD8\xB1\xF5 \xB7_D\n\x9A">, @public_key=#<Secp256k1::PublicKey:0x00005574a6998160>>
+key.public_hex
+# => "04b45200621c013a5fbab999ac33b0c836328a04afa0255ffbe6ea0f6fd97e187b02199886d942a9f50f7e279a2bc74c93b2afcbd7255489939f9b36a5eae5e281"
+key.address.to_s
+# => "0xD496b23D61F88A8C7758fca7560dCFac7b3b01F9"
+key.personal_sign "Hello World!"
+# => "ac6a59417d8688c8144f01a662384fa691636b48a071d4b7c13902bb87ca472b0bce1d7a758f39a5759ed5e937ce61f50dd1b83158371f8d0faeb9b7d81c194225"
 ```
 
-### Transactions
-
-Build a transaction from scratch:
+Recover and verify personal signatures respecting EIPs 155, 191, and 712.
 
 ```ruby
-tx = Eth::Tx.new({
-  data: hex_data,
-  gas_limit: 21_000,
-  gas_price: 3_141_592,
-  nonce: 1,
-  to: key2.address,
-  value: 1_000_000_000_000,
-})
+address = Eth::Address.new "0xd496b23d61f88a8c7758fca7560dcfac7b3b01f9"
+# => #<Eth::Address:0x00005574a6bd4fc8 @address="0xd496b23d61f88a8c7758fca7560dcfac7b3b01f9">
+signature = "ac6a59417d8688c8144f01a662384fa691636b48a071d4b7c13902bb87ca472b0bce1d7a758f39a5759ed5e937ce61f50dd1b83158371f8d0faeb9b7d81c19422d"
+# => "ac6a59417d8688c8144f01a662384fa691636b48a071d4b7c13902bb87ca472b0bce1d7a758f39a5759ed5e937ce61f50dd1b83158371f8d0faeb9b7d81c19422d"
+recovered_key = Eth::Signature.personal_recover "Hello World!", signature, Eth::Chain::GOERLI
+# => "04b45200621c013a5fbab999ac33b0c836328a04afa0255ffbe6ea0f6fd97e187b02199886d942a9f50f7e279a2bc74c93b2afcbd7255489939f9b36a5eae5e281"
+Eth::Util.public_key_to_address(recovered_key).to_s
+# => "0xD496b23D61F88A8C7758fca7560dCFac7b3b01F9"
+Eth::Signature.verify "Hello World!", signature, address, Eth::Chain::GOERLI
+# => true
 ```
 
-Or decode an encoded raw transaction:
+See `/spec` or [Documentation](https://q9f.github.io/eth.rb/) for signing typed data as per EIP-712.
+
+### 2.3. Ethereum Chains (EIP-155)
+Manage Ethereum chain IDs for EIP-155 replay protection.
 
 ```ruby
-tx = Eth::Tx.decode hex
+chain_id = Eth::Chain::OPTIMISM
+# => 10
+v = Eth::Chain.to_v 0, Eth::Chain::OPTIMISM
+# => 55
+recovery_id = Eth::Chain.to_recovery_id v, Eth::Chain::OPTIMISM
+# => 0
+chain_id = Eth::Chain.to_chain_id v
+# => 10
 ```
 
-Then sign the transaction:
+### 2.4. Ethereum Transactions (EIP-1559, EIP-2718, EIP-2930)
+Create an EIP-1559-conform transaction:
 
 ```ruby
-tx.sign key
+payload = {
+  chain_id: Eth::Chain::GOERLI,
+  nonce: 5,
+  priority_fee: 3 * Eth::Unit::GWEI,
+  max_gas_fee: 69 * Eth::Unit::GWEI,
+  gas_limit: 230_420,
+  to: "0xCaA29806044A08E533963b2e573C1230A2cd9a2d",
+  value: 0.069423 * Eth::Unit::ETHER,
+}
+# => {:chain_id=>5, :nonce=>5, :priority_fee=>0.3e10, :max_gas_fee=>0.69e11, :gas_limit=>230420, :to=>"0xCaA29806044A08E533963b2e573C1230A2cd9a2d", :value=>0.69423e17}
+tx = Eth::Tx.new payload
+# => #<Eth::Tx::Eip1559:0x0000557e35fc5a68 @access_list=[], @amount=69423000000000000, @chain_id=5, @destination="CaA29806044A08E533963b2e573C1230A2cd9a2d", @gas_limit=230420, @max_fee_per_gas=69000000000, @max_priority_fee_per_gas=3000000000, @payload="", @sender="", @signature_r=0, @signature_s=0, @signature_y_parity=nil, @signer_nonce=5, @type=2>
+my_key = Eth::Key.new priv: "30137644b564785d01420f8043f043d74dcca64008e57c59f8ce713a0005a54b"
+# => #<Eth::Key:0x0000557e36243178 @private_key=#<Secp256k1::PrivateKey:0x0000557e36242d40 @data="0\x13vD\xB5dx]\x01B\x0F\x80C\xF0C\xD7M\xCC\xA6@\b\xE5|Y\xF8\xCEq:\x00\x05\xA5K">, @public_key=#<Secp256k1::PublicKey:0x0000557e36242cf0>>
+tx.sign my_key
+# => "cba302c0ebf8d0205a78ae97f560419b407e32e2426f416abc95a9bfc9dac09c"
+tx.hex
+# => "02f873050584b2d05e00851010b872008303841494caa29806044a08e533963b2e573c1230a2cd9a2d87f6a3d9c63df00080c080a03aa187d10b138d3e0155729adb961cd89e10f988ba2d19d6869770b9e5a23d10a04d40864600136ae214916043c7d63b849c98db757e95c86983a036982816e1af"
 ```
 
-Get the raw transaction with `tx.hex`, and broadcast it through any Ethereum node. Or, just get the TXID with `tx.hash`.
+This gem also supports access lists and ABI-encoded data payloads. See `/spec` or [Documentation](https://q9f.github.io/eth.rb/) for more details about the various supported transaction types (legacy, type-1, type-2), payload parameters, and how to estimate intrinsic gas costs.
 
-### Utils
-
-Validate an [EIP55](https://github.com/ethereum/EIPs/issues/55) checksummed address:
+### 2.5. Ethereum ABI Encoder and Decoder
+Encode and decode Ethereum application binary interface data (ABI).
 
 ```ruby
-Eth::Utils.valid_address? address
+Eth::Util.bin_to_hex Eth::Abi.encode(["string", "address"], ["Hello, Bob!", "0xd496b23d61f88a8c7758fca7560dcfac7b3b01f9"])
+# => "0000000000000000000000000000000000000000000000000000000000000040000000000000000000000000d496b23d61f88a8c7758fca7560dcfac7b3b01f9000000000000000000000000000000000000000000000000000000000000000b48656c6c6f2c20426f6221000000000000000000000000000000000000000000"
+Eth::Abi.decode(["string", "address"], "0000000000000000000000000000000000000000000000000000000000000040000000000000000000000000d496b23d61f88a8c7758fca7560dcfac7b3b01f9000000000000000000000000000000000000000000000000000000000000000b48656c6c6f2c20426f6221000000000000000000000000000000000000000000")
+# => ["Hello, Bob!", "0xd496b23d61f88a8c7758fca7560dcfac7b3b01f9"]
 ```
 
-Or add a checksum to an existing address:
+### 2.6. Ethereum RLP Encoder and Decoder
+Serialize and deserialize Ethereum recursive-length prefix data (RLP).
 
 ```ruby
-Eth::Utils.format_address "0x4bc787699093f11316e819b5692be04a712c4e69" # => "0x4bc787699093f11316e819B5692be04A712C4E69"
+Eth::Util.bin_to_hex Eth::Rlp.encode ["Hello, Bob!", "0xd496b23d61f88a8c7758fca7560dcfac7b3b01f9"]
+# => "f78b48656c6c6f2c20426f6221aa307864343936623233643631663838613863373735386663613735363064636661633762336230316639"
+Eth::Rlp.decode "f78b48656c6c6f2c20426f6221aa307864343936623233643631663838613863373735386663613735363064636661633762336230316639"
+# => ["Hello, Bob!", "0xd496b23d61f88a8c7758fca7560dcfac7b3b01f9"]
 ```
 
-### Personal Signatures
+Or ;-)
+
+```ruby
+Eth::Rlp.decode "c7c0c1c0c3c0c1c0"
+# => [[], [[]], [[], [[]]]]
+```
 
-You can recover public keys and generate web3/metamask-compatible signatures:
+### 2.7. Ethereum RPC-Client
+Create an IPC- or HTTP-RPC-API client to seamlessly query the chain state, e.g., Infura over HTTPS with access token:
 
 ```ruby
-# Generate signature
-key.personal_sign('hello world')
+infura = Eth::Client.create "https://mainnet.infura.io/v3/#{access_token}"
+# => #<Eth::Client::Http:0x000055d43f3ca460 @gas_limit=21000, @host="mainnet.infura.io", @id=0, @max_fee_per_gas=0.2e11, @max_priority_fee_per_gas=0, @port=443, @ssl=true, @uri=#<URI::HTTPS https://mainnet.infura.io/v3/31b...d93>>
+deposit_contract = Eth::Address.new "0x00000000219ab540356cBB839Cbe05303d7705Fa"
+# => #<Eth::Address:0x000055d43f381738 @address="0x00000000219ab540356cBB839Cbe05303d7705Fa">
+infura.get_balance deposit_contract
+# => 9087314000069000000000069
+```
+
+Or set up a local development environment with `geth --dev`:
 
-# Recover signature
-message = 'test'
-signature = '0x3eb24bd327df8c2b614c3f652ec86efe13aa721daf203820241c44861a26d37f2bffc6e03e68fc4c3d8d967054c9cb230ed34339b12ef89d512b42ae5bf8c2ae1c'
-Eth::Key.personal_recover(message, signature) # => 043e5b33f0080491e21f9f5f7566de59a08faabf53edbc3c32aaacc438552b25fdde531f8d1053ced090e9879cbf2b0d1c054e4b25941dab9254d2070f39418afc
+```ruby
+cli = Eth::Client.create "/tmp/geth.ipc"
+# => #<Eth::Client::Ipc:0x000055d43f51c390 @gas_limit=21000, @id=0, @max_fee_per_gas=0.2e11, @max_priority_fee_per_gas=0, @path="/tmp/geth.ipc">
+cli.eth_coinbase
+# => {"jsonrpc"=>"2.0", "id"=>1, "result"=>"0x6868074fb21c48dfad0c448fbabd99383a6598e4"}
+tx = cli.transfer_and_wait(Eth::Key.new.address, 1337 * Eth::Unit::ETHER)
+# => "0x141c6dff40df34fe4fce5a65588d2161dab3e0e977fb8049ff7d79bc901034f7"
+cli.eth_get_transaction_by_hash tx
+# => {"jsonrpc"=>"2.0", "id"=>8, "result"=> {"blockHash"=>"0x47e742038c75851348dbda87b15fde044d54c442c371f43bea881a44d5589de3", "blockNumber"=>"0x1", "from"=>"0x6868074fb21c48dfad0c448fbabd99383a6598e4", "gas"=>"0x5208", "gasPrice"=>"0x342770c1", "maxFeePerGas"=>"0x77359401", "maxPriorityFeePerGas"=>"0x1", "hash"=>"0x141c6dff40df34fe4fce5a65588d2161dab3e0e977fb8049ff7d79bc901034f7", "input"=>"0x", "nonce"=>"0x0", "to"=>"0x311c61e5dc6123ad016bb7fd687d283c327bcd5f", "transactionIndex"=>"0x0", "value"=>"0x487a9a304539440000", "type"=>"0x2", "accessList"=>[], "chainId"=>"0x539", "v"=>"0x0", "r"=>"0xb42477d69eae65a3a3d91d9cb173e4a45a403fb0a15fa729dbfdc9d13211d7b5", "s"=>"0x4a2f98fc2b61c2d7c907520bc8c6ebe42ea6fe1cb6824f95e4b30e9464395100"}}
+cli.get_balance "0x311c61e5dc6123ad016bb7fd687d283c327bcd5f"
+# => 1337000000000000000000
+cli.get_nonce cli.eth_coinbase["result"]
+# => 1
 ```
 
-### Configure
+Check out `Eth::Api` for a list of supported RPC-APIs or consult the [Documentation](https://q9f.github.io/eth.rb/) for more details.
 
-In order to prevent replay attacks, you must specify which Ethereum chain your transactions are created for. See [EIP 155](https://github.com/ethereum/EIPs/issues/155) for more detail.
+### 2.8 Solidity Compiler Bindings
+Link a system-level Solidity compiler (`solc`) to your Ruby library and compile contracts.
 
 ```ruby
-Eth.configure do |config|
-  config.chain_id = 1 # nil by default, meaning valid on any chain
-end
+solc = Eth::Solidity.new
+# => #<Eth::Solidity:0x000055f05040c6d0 @compiler="/usr/bin/solc">
+contract = solc.compile "spec/fixtures/contracts/greeter.sol"
+# => {"Greeter"=>
+#   {"abi"=>
+#     [{"inputs"=>[{"internalType"=>"string", "name"=>"message", "type"=>"string"}], "stateMutability"=>"nonpayable", "type"=>"constructor"},
+#      {"inputs"=>[], "name"=>"greet", "outputs"=>[{"internalType"=>"string", "name"=>"", "type"=>"string"}], "stateMutability"=>"view", "type"=>"function"},
+#      {"inputs"=>[], "name"=>"kill", "outputs"=>[], "stateMutability"=>"nonpayable", "type"=>"function"}],
+#    "bin"=>
+#     "6080604052348015...6c634300080c0033"},
+#  "Mortal"=>
+#   {"abi"=>[{"inputs"=>[], "stateMutability"=>"nonpayable", "type"=>"constructor"}, {"inputs"=>[], "name"=>"kill", "outputs"=>[], "stateMutability"=>"nonpayable", "type"=>"function"}],
+#    "bin"=>
+#     "6080604052348015...6c634300080c0033"}}
 ```
 
-## Contributing
+The `contract["Greeter"]["bin"]` could be directly used to deploy the contract as `Eth::Tx` payload. Check out the [Documentation](https://q9f.github.io/eth.rb/) for more details.
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/se3000/ruby-eth. Tests are encouraged.
+## 3. Documentation
+The documentation can be found at: https://q9f.github.io/eth.rb
 
-### Tests
+For any specific version, docs can be generated by `yard`:
 
-First install the [Ethereum common tests](https://github.com/ethereum/tests):
+```shell
+gem install bundler rdoc yard
+git checkout v0.5.0
+yard doc
+```
+
+The goal is to have 100% API documentation available.
+
+## 4. Testing
+The test suite expects working local HTTP and IPC endpoints with a prefunded developer account, e.g.:
 
 ```shell
-git submodule update --init
+geth --dev --http --ipcpath /tmp/geth.ipc &
 ```
 
-Then run the associated tests:
+To run tests, simply use `rspec`. Note, that the Ethereum test fixtures are also required.
 
 ```shell
+git submodule update --init --recursive
+bundle install
 rspec
 ```
 
-## License
+The goal is to have 100% specification coverage for all code inside this gem.
+
+## 5. 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: https://github.com/q9f/eth.rb
+
+## 6. 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.
+* https://github.com/se3000/ruby-eth/ (MIT)
 
-The gem is available as open-source software under the terms of the [MIT License](http://opensource.org/licenses/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.
+* https://github.com/EthWorks/ethereum.rb (MIT)
 
-## TODO
+This gem also includes a revised version of the ABI gem by Jan Xie and Zhang Yaning.
+* https://github.com/cryptape/ruby-ethereum-abi (MIT)
 
-* Better test suite.
-* Expose API for HD keys.
-* Support signing with [libsecp256k1](https://github.com/bitcoin-core/secp256k1).
+It also contains a condensed version of the RLP gem by Jan Xie and Zhang Yaning.
+* https://github.com/cryptape/ruby-rlp (MIT)

data/bin/console

@@ -1,10 +1,10 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "eth"
+# use the local version of the code instead of a globally installed gem
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
 
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
+require "eth"
+include Eth
 
 require "pry"
 Pry.start

data/bin/setup

@@ -1,8 +1,9 @@
 #!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
 
 bundle install
+git submodule update --init --recursive
+rufo .
+yard doc
+rspec
 
-# Do any other automated setup that you need to do here
+echo "Tests fail? Run \`geth --dev --http --ipcpath /tmp/geth.ipc\` in background and try again."

data/codecov.yml

@@ -0,0 +1,6 @@
+coverage:
+  status:
+    project:
+      default:
+        target: 99%
+        threshold: 1%

data/eth.gemspec

@@ -12,16 +12,17 @@ Gem::Specification.new do |spec|
   spec.authors = ["Steve Ellis", "Afri Schoedon"]
   spec.email = ["email@steveell.is", "ruby@q9f.cc"]
 
-  spec.summary = %q{Simple API to sign Ethereum transactions.}
-  spec.description = %q{Library to build, parse, and sign Ethereum transactions.}
-  spec.homepage = "https://github.com/se3000/ruby-eth"
-  spec.license = "MIT"
+  spec.summary = %q{Ruby Ethereum library.}
+  spec.description = %q{Library to handle Ethereum accounts, messages, and transactions.}
+  spec.homepage = "https://github.com/q9f/eth.rb"
+  spec.license = "Apache-2.0"
 
   spec.metadata = {
-    "homepage_uri" => "https://github.com/se3000/ruby-eth",
-    "source_code_uri" => "https://github.com/se3000/ruby-eth",
-    "github_repo" => "https://github.com/se3000/ruby-eth",
-    "bug_tracker_uri" => "https://github.com/se3000/ruby-eth/issues",
+    "bug_tracker_uri" => "https://github.com/q9f/eth.rb/issues",
+    "changelog_uri" => "https://github.com/q9f/eth.rb/blob/main/CHANGELOG.md",
+    "documentation_uri" => "https://q9f.github.io/eth.rb/",
+    "github_repo" => "https://github.com/q9f/eth.rb",
+    "source_code_uri" => "https://github.com/q9f/eth.rb",
   }.freeze
 
   spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
@@ -30,18 +31,21 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.test_files = spec.files.grep %r{^(test|spec|features)/}
 
-  spec.add_dependency "keccak", "~> 1.3"
-  spec.add_dependency "ffi", "~> 1.15"
-  spec.add_dependency "money-tree", "~> 0.11"
-  spec.add_dependency "openssl", "~> 3.0"
-  spec.add_dependency "rlp", "~> 0.7"
-  spec.add_dependency "scrypt", "~> 3.0"
-
   spec.platform = Gem::Platform::RUBY
   spec.required_ruby_version = ">= 2.6", "< 4.0"
 
-  spec.add_development_dependency "bundler", "~> 2.2"
-  spec.add_development_dependency "pry", "~> 0.14"
-  spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "rspec", "~> 3.10"
+  # keccak for hashing everything in ethereum
+  spec.add_dependency "keccak", "~> 1.3"
+
+  # konstructor gem for overloading constructors
+  spec.add_dependency "konstructor", "~> 1.0"
+
+  # rbsecp256k1 for key-pairs and signatures
+  spec.add_dependency "rbsecp256k1", "~> 5.1"
+
+  # openssl for encrypted key derivation
+  spec.add_dependency "openssl", "~> 2.2"
+
+  # scrypt for encrypted key derivation
+  spec.add_dependency "scrypt", "~> 3.0"
 end