eth 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2e1ab048011cd64dd6d4662e2fd203e1fc2eceeaa54f0a51d16659f9de910d1
-  data.tar.gz: b54597a0b06c94919fdd9c06a7c663d3c55f83f7210085496fbae32402e578e8
+  metadata.gz: 90f2afdedcf09191090c54dbfa45438e5be7d0f94d5badc0b09e0d678d52f9bf
+  data.tar.gz: 05de6ecc688e5d11a50324d8707e092c91d422c6f11f02a1479a4645bce95c6e
 SHA512:
-  metadata.gz: 9fb243d28dd7407f3e595d8474fb64a47a76abff7b2a3bccdd8cae5a31ddfeb1598ed62fd01a78b54103fbe613ee357bb11356d9866e9743a066b8757da725e6
-  data.tar.gz: 6e7912c298278d60b640e7728cba2550e9443e1c8dab63a1e797163570fdeefe797f4cf4535214eeb0461cbbed9cf604f4bea9850fd3b857d8ad83c3134c76db
+  metadata.gz: d2d2eea96edfca3d94d4d23b4eabcb70dbc0ea33fd735ba13929130882d48b973fd8f242caaa39e49a3384f45bba87b39eb86b77ce539c416394c37ce989df97
+  data.tar.gz: 551c6cc113f279a91b900434ee446abf5fcd2d7ce1efb3cea294fc3531e250f9ef42068f22c57712f827bf756c95fde11ad7a481d53578f64d3631d7a5b2f795

data/.github/workflows/codeql.yml

@@ -42,3 +42,7 @@ jobs:
           gem install rufo
           rufo --check ./lib
           rufo --check ./spec
+      - name: "Run yard documentation checks"
+        run: |
+          gem install yard
+          yard doc --fail-on-warning

data/.github/workflows/spec.yml

@@ -26,11 +26,22 @@ jobs:
       with:
         ruby-version: ${{ matrix.ruby }}
         bundler-cache: false
-    - name: Homebrew maketools
+    - name: MacOs Dependencies
       run: |
-        brew install --verbose pkg-config automake autogen
+        brew tap ethereum/ethereum
+        brew install --verbose pkg-config automake autogen ethereum
       if: startsWith(matrix.os, 'macOS')
-    - name: Install Dependencies
+    - name: Ubuntu Dependencies
+      run: |
+        sudo add-apt-repository -y ppa:ethereum/ethereum
+        sudo apt-get update
+        sudo apt-get install ethereum
+      if: startsWith(matrix.os, 'Ubuntu')
+    - name: Run Geth
+      run: |
+        geth --dev --http --ipcpath /tmp/geth.ipc &
+        disown &
+    - name: Gem Dependencies
       run: |
         git submodule update --init
         bundle install

data/.yardopts

@@ -0,0 +1 @@
+--verbose --fail-on-warning --markup markdown --embed-mixins

data/AUTHORS.txt

@@ -14,3 +14,8 @@ The latest version of the Ruby-Eth gem contains a revised version the
 ABI gem by Jan Xie (@janx) and Zhang Yaning (@u2) licensed under MIT
 conditions:
 * https://github.com/cryptape/ruby-ethereum-abi
+
+The latest version of the Ruby-Eth gem contains a revised version the
+RLP gem by Jan Xie (@janx) and Zhang Yaning (@u2) licensed under MIT
+conditions:
+* https://github.com/cryptape/ruby-rlp

data/CHANGELOG.md

@@ -1,25 +1,75 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-The format is based on [Keep a Changelog](http://keepachangelog.com/)
-and this project adheres to [Semantic Versioning](http://semver.org/).
-
-### Unreleased
+## [0.5.1]
+### Changed
+- Docs: update changelog ([#61](https://github.com/q9f/eth.rb/pull/61))
+- Eth/chain: add sepolia chain id; docs ([#60](https://github.com/q9f/eth.rb/pull/60))
+- Eth/rlp: cleanup ([#59](https://github.com/q9f/eth.rb/pull/59))
+- Add eth::rlp module ([#52](https://github.com/q9f/eth.rb/pull/52))
+- Eth/tx: properly serialize signatures ([#58](https://github.com/q9f/eth.rb/pull/58))
+- Eth/client: fix legacy transfer ([#57](https://github.com/q9f/eth.rb/pull/57))
+- Gem: relax openssl requirement ([#56](https://github.com/q9f/eth.rb/pull/56))
+- Eth/client: implement http/ipc ([#37](https://github.com/q9f/eth.rb/pull/37))
+- Docs: update changelog ([#53](https://github.com/q9f/eth.rb/pull/53))
+- Spec: add upstream test fixtures for keystore ([#50](https://github.com/q9f/eth.rb/pull/50))
+
+## [0.5.0]
+### Changed
+- Docs: update readme with features [#49](https://github.com/q9f/eth.rb/pull/49)
+- Eth/tx: add method to estimate intrinsic gas costs [#48](https://github.com/q9f/eth.rb/pull/48)
+- Eth/key: allow chain_id empty for signing messages/data [#47](https://github.com/q9f/eth.rb/pull/47)
+- Gem: prepare for release [#46](https://github.com/q9f/eth.rb/pull/46)
+- Eth/sig: allow v values > 0xff, fix #30 [#43](https://github.com/q9f/eth.rb/pull/43)
+- Eth/abi: refactor for maintainability [#42](https://github.com/q9f/eth.rb/pull/42)
+- Docs: improve readme [#41](https://github.com/q9f/eth.rb/pull/41)
+- Lib: improve error handling [#39](https://github.com/q9f/eth.rb/pull/39)
+- Docs: update readme for tx and keys [#40](https://github.com/q9f/eth.rb/pull/40)
+- Implement encrypt/decrypt [#22](https://github.com/q9f/eth.rb/pull/22)
+- Eth/tx: create legacy, type-1, and type-2 transactions [#33](https://github.com/q9f/eth.rb/pull/33)
+- Gem: clean up some docs and scripts [#32](https://github.com/q9f/eth.rb/pull/32)
+- Signature: implement eip 712 typed structured data signing [#27](https://github.com/q9f/eth.rb/pull/27)
+- Lib: import ABI to eth/abi [#29](https://github.com/q9f/eth.rb/pull/29)
+- Rename util and chain to singular [#26](https://github.com/q9f/eth.rb/pull/26)
+- Docs: add some examples to readme [#25](https://github.com/q9f/eth.rb/pull/25)
+- Key/signature: personal sign and verify [#24](https://github.com/q9f/eth.rb/pull/24)
+- Ci: only run coverage on CI [#23](https://github.com/q9f/eth.rb/pull/23)
+- Lib/signature: implement personal_recover (eip 191 [#21](https://github.com/q9f/eth.rb/pull/21)
+- Eth/chains: implement eip 155 for replay protection [#20](https://github.com/q9f/eth.rb/pull/20)
+- Eth/util: public_key_to_address should return an eth::address [#19](https://github.com/q9f/eth.rb/pull/19)
+- Ci: add docs workflow [#18](https://github.com/q9f/eth.rb/pull/18)
+- Address class implementation and tests [#13](https://github.com/q9f/eth.rb/pull/13)
+- Spec: improve util tests [#12](https://github.com/q9f/eth.rb/pull/12)
+- Spec: improve key tests [#11](https://github.com/q9f/eth.rb/pull/11)
+- Gems: bump keccak and secp256k1 [#10](https://github.com/q9f/eth.rb/pull/10)
+- Docs: add code climate badge [#8](https://github.com/q9f/eth.rb/pull/8)
+- Ci: enable codecov [#7](https://github.com/q9f/eth.rb/pull/7)
+- Docs: add AUTHORS file [#6](https://github.com/q9f/eth.rb/pull/6)
+- Lib: implement Eth::Key class [#4](https://github.com/q9f/eth.rb/pull/4)
+- Ci: add nightly schedule [#2](https://github.com/q9f/eth.rb/pull/2)
+- Reset gem to point blank [#1](https://github.com/q9f/eth.rb/pull/1)
+
+## [0.4.18]
+### Changed
+- CI: add yard doc and rufo workflows [se3000/ruby-eth#75](https://github.com/se3000/ruby-eth/pull/75)
+- Gem: run rufo [se3000/ruby-eth#74](https://github.com/se3000/ruby-eth/pull/74)
+- Gem: dependencies [se3000/ruby-eth#73](https://github.com/se3000/ruby-eth/pull/73)
+- Lib: fix compatibility with libressl (macos) and openssl 1.1.1k [se3000/ruby-eth#66](https://github.com/se3000/ruby-eth/pull/66)
 
 ## [0.4.17]
 ### Changed
-- Gems: bump version to 0.4.17 [#70](https://github.com/se3000/ruby-eth/pull/70)
-- Gems: bump keccak to 1.3.0 [#69](https://github.com/se3000/ruby-eth/pull/69)
+- Gems: bump version to 0.4.17 [se3000/ruby-eth#70](https://github.com/se3000/ruby-eth/pull/70)
+- Gems: bump keccak to 1.3.0 [se3000/ruby-eth#69](https://github.com/se3000/ruby-eth/pull/69)
 
 ## [0.4.16]
 ### Changed
-- Docs: update changelog [#65](https://github.com/se3000/ruby-eth/pull/65)
-- Gems: bump version to 0.4.16 [#65](https://github.com/se3000/ruby-eth/pull/65)
-- License: update copyright notice [#64](https://github.com/se3000/ruby-eth/pull/64)
-- Docs: add badges to readme [#64](https://github.com/se3000/ruby-eth/pull/64)
-- Git: deprecating master [#63](https://github.com/se3000/ruby-eth/pull/63)
-- CI: replace travis with github actions [#62](https://github.com/se3000/ruby-eth/pull/62)
-- Gems: replace digest-sha3-patched with keccak [#58](https://github.com/se3000/ruby-eth/pull/58)
+- Docs: update changelog [se3000/ruby-eth#65](https://github.com/se3000/ruby-eth/pull/65)
+- Gems: bump version to 0.4.16 [se3000/ruby-eth#65](https://github.com/se3000/ruby-eth/pull/65)
+- License: update copyright notice [se3000/ruby-eth#64](https://github.com/se3000/ruby-eth/pull/64)
+- Docs: add badges to readme [se3000/ruby-eth#64](https://github.com/se3000/ruby-eth/pull/64)
+- Git: deprecating master [se3000/ruby-eth#63](https://github.com/se3000/ruby-eth/pull/63)
+- CI: replace travis with github actions [se3000/ruby-eth#62](https://github.com/se3000/ruby-eth/pull/62)
+- Gems: replace digest-sha3-patched with keccak [se3000/ruby-eth#58](https://github.com/se3000/ruby-eth/pull/58)
 
 ## [0.4.13], [0.4.14], [0.4.15]
 _Released as [`eth-patched`](https://github.com/q9f/ruby-eth) from a different source tree._

data/README.md

@@ -23,10 +23,10 @@ What you get:
 - [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
 
 Soon (TM):
-- [ ] RLP-Encoder and Decoder (including sedes)
-- [ ] RPC-Client (HTTP) for Execution APIs and Consensus APIs
 - [ ] Smart Contracts and Solidity Support
 - [ ] EIP-1271 Smart-Contract Authentification
 - [ ] HD-Wallets (BIP-32) and Mnemonics (BIP-39)
@@ -39,6 +39,8 @@ Contents:
   - [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)
 - [3. Documentation](#3-documentation)
 - [4. Testing](#4-testing)
 - [5. Contributing](#5-contributing)
@@ -177,6 +179,56 @@ Eth::Abi.decode(["string", "address"], "0000000000000000000000000000000000000000
 # => ["Hello, Bob!", "0xd496b23d61f88a8c7758fca7560dcfac7b3b01f9"]
 ```
 
+### 2.6. Ethereum RLP Encoder and Decoder
+
+Serialize and deserialize Ethereum recursive-length prefix data (RLP).
+
+```ruby
+Eth::Util.bin_to_hex Eth::Rlp.encode ["Hello, Bob!", "0xd496b23d61f88a8c7758fca7560dcfac7b3b01f9"]
+# => "f78b48656c6c6f2c20426f6221aa307864343936623233643631663838613863373735386663613735363064636661633762336230316639"
+Eth::Rlp.decode "f78b48656c6c6f2c20426f6221aa307864343936623233643631663838613863373735386663613735363064636661633762336230316639"
+# => ["Hello, Bob!", "0xd496b23d61f88a8c7758fca7560dcfac7b3b01f9"]
+```
+
+Or ;-)
+
+```ruby
+Eth::Rlp.decode "c7c0c1c0c3c0c1c0"
+# => [[], [[]], [[], [[]]]]
+```
+
+### 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
+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`:
+
+```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
+```
+
+Check out `Eth::Api` for a list of supported RPC-APIs or consult the [Documentation](https://q9f.github.io/eth.rb/) for more details.
+
 ## 3. Documentation
 
 The documentation can be found at: https://q9f.github.io/eth.rb
@@ -219,3 +271,6 @@ This gem is a complete rewrite of the old `eth` gem by Steve Ellis.
 
 It also contains a revised version the ABI gem by Jan Xie and Zhang Yaning.
 * https://github.com/cryptape/ruby-ethereum-abi (MIT)
+
+It also contains a revised version the RLP gem by Jan Xie and Zhang Yaning.
+* https://github.com/cryptape/ruby-rlp (MIT)

data/bin/console

@@ -4,6 +4,7 @@
 $LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
 
 require "eth"
-require "pry"
+include Eth
 
+require "pry"
 Pry.start

data/bin/setup

@@ -1,10 +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
+
+echo "Tests fail? Run \`geth --dev --http --ipcpath /tmp/geth.ipc\` in background and try again."

data/eth.gemspec

@@ -18,10 +18,11 @@ Gem::Specification.new do |spec|
   spec.license = "Apache-2.0"
 
   spec.metadata = {
-    "homepage_uri" => "https://github.com/q9f/eth.rb",
-    "source_code_uri" => "https://github.com/q9f/eth.rb",
-    "github_repo" => "https://github.com/q9f/eth.rb",
     "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)/}) }
@@ -42,11 +43,8 @@ Gem::Specification.new do |spec|
   # rbsecp256k1 for key-pairs and signatures
   spec.add_dependency "rbsecp256k1", "~> 5.1"
 
-  # rlp for transaction encoding
-  spec.add_dependency "rlp", "~> 0.7"
-
   # openssl for encrypted key derivation
-  spec.add_dependency "openssl", "~> 3.0"
+  spec.add_dependency "openssl", "~> 2.2"
 
   # scrypt for encrypted key derivation
   spec.add_dependency "scrypt", "~> 3.0"

data/lib/eth/abi/type.rb

@@ -14,7 +14,7 @@
 
 # -*- encoding : ascii-8bit -*-
 
-# Provides the `Eth` module.
+# Provides the {Eth} module.
 module Eth
 
   # Provides a Ruby implementation of the Ethereum Applicatoin Binary Interface (ABI).
@@ -26,7 +26,7 @@ module Eth
       # Provides a specific parser error if type cannot be determined.
       class ParseError < StandardError; end
 
-      # The base attribute, e.g., `string` or `bytes`
+      # The base attribute, e.g., `string` or `bytes`.
       attr :base_type
 
       # The sub-type attribute, e.g., `256` as size of an uint256.
@@ -36,7 +36,7 @@ module Eth
       attr :dimensions
 
       # Create a new Type object for base types, sub types, and dimensions.
-      # Should use the `Type.parse` parser.
+      # Should not be used; use {Type.parse} instead.
       #
       # @param base_type [String] the base-type attribute.
       # @param sub_type [String] the sub-type attribute.
@@ -75,7 +75,7 @@ module Eth
         @dimensions = dims.map { |x| x[1...-1].to_i }
       end
 
-      # Creata new uint256 type used for size.
+      # Creates a new uint256 type used for size.
       #
       # @return [Eth::Abi::Type] a uint256 size type.
       def self.size_type
@@ -85,7 +85,7 @@ module Eth
       # Compares two types for their attributes.
       #
       # @param another_type [Eth::Abi::Type] another type to be compared.
-      # @return [Bool] true if all attributes match.
+      # @return [Boolean] true if all attributes match.
       def ==(another_type)
         base_type == another_type.base_type and
           sub_type == another_type.sub_type and
@@ -111,9 +111,9 @@ module Eth
         @size ||= s
       end
 
-      # Helper to determine whether array is of dynamic size.
+      # Helpes to determine whether array is of dynamic size.
       #
-      # @return [Bool] true if array is of dynamic size.
+      # @return [Boolean] true if array is of dynamic size.
       def is_dynamic?
         size.nil?
       end
@@ -127,6 +127,7 @@ module Eth
 
       private
 
+      # Validates all known base types and raises if an issue occurs.
       def validate_base_type(base_type, sub_type)
         case base_type
         when "string"

data/lib/eth/abi.rb

@@ -16,17 +16,15 @@
 
 require "konstructor"
 
-require "eth/abi/constant"
 require "eth/abi/type"
 
-# Provides the `Eth` module.
+# Provides the {Eth} module.
 module Eth
 
   # Provides a Ruby implementation of the Ethereum Applicatoin Binary Interface (ABI).
   # ref: https://docs.soliditylang.org/en/develop/abi-spec.html
   module Abi
     extend self
-    include Constant
 
     # Provides a special encoding error if anything fails to encode.
     class EncodingError < StandardError; end
@@ -71,7 +69,7 @@ module Eth
     # Encodes a specific value, either static or dynamic.
     #
     # @param type [Eth::Abi::Type] type to be encoded.
-    # @param arg [String, Number] value to be encoded.
+    # @param arg [String|Number] value to be encoded.
     # @return [String] the encoded type.
     # @raise [EncodingError] if value does not match type.
     def encode_type(type, arg)
@@ -80,7 +78,7 @@ module Eth
 
         # encodes strings and bytes
         size = encode_type Type.size_type, arg.size
-        padding = BYTE_ZERO * (Util.ceil32(arg.size) - arg.size)
+        padding = Constant::BYTE_ZERO * (Util.ceil32(arg.size) - arg.size)
         return "#{size}#{arg}#{padding}"
       elsif type.is_dynamic?
         raise EncodingError, "Argument must be an Array" unless arg.instance_of? Array
@@ -113,7 +111,7 @@ module Eth
     # Encodes primitive types.
     #
     # @param type [Eth::Abi::Type] type to be encoded.
-    # @param arg [String, Number] value to be encoded.
+    # @param arg [String|Number] value to be encoded.
     # @return [String] the encoded primitive type.
     # @raise [EncodingError] if value does not match type.
     # @raise [ValueOutOfBounds] if value is out of bounds for type.
@@ -286,7 +284,7 @@ module Eth
       when "bool"
 
         # decoded boolean
-        return data[-1] == BYTE_ONE
+        return data[-1] == Constant::BYTE_ONE
       else
         raise DecodingError, "Unknown primitive type: #{type.base_type}"
       end
@@ -294,33 +292,38 @@ module Eth
 
     private
 
+    # Properly encodes unsigned integers.
     def encode_uint(arg, type)
-      raise ValueOutOfBounds, "Number out of range: #{arg}" if arg > UINT_MAX or arg < UINT_MIN
+      raise ValueOutOfBounds, "Number out of range: #{arg}" if arg > Constant::UINT_MAX or arg < Constant::UINT_MIN
       real_size = type.sub_type.to_i
       i = arg.to_i
       raise ValueOutOfBounds, arg unless i >= 0 and i < 2 ** real_size
       return Util.zpad_int i
     end
 
+    # Properly encodes signed integers.
     def encode_int(arg, type)
-      raise ValueOutOfBounds, "Number out of range: #{arg}" if arg > INT_MAX or arg < INT_MIN
+      raise ValueOutOfBounds, "Number out of range: #{arg}" if arg > Constant::INT_MAX or arg < Constant::INT_MIN
       real_size = type.sub_type.to_i
       i = arg.to_i
       raise ValueOutOfBounds, arg unless i >= -2 ** (real_size - 1) and i < 2 ** (real_size - 1)
       return Util.zpad_int(i % 2 ** type.sub_type.to_i)
     end
 
+    # Properly encodes booleans.
     def encode_bool(arg)
       raise EncodingError, "Argument is not bool: #{arg}" unless arg.instance_of? TrueClass or arg.instance_of? FalseClass
       return Util.zpad_int(arg ? 1 : 0)
     end
 
+    # Properly encodes unsigned fixed-point numbers.
     def encode_ufixed(arg, type)
       high, low = type.sub_type.split("x").map(&:to_i)
       raise ValueOutOfBounds, arg unless arg >= 0 and arg < 2 ** high
       return Util.zpad_int((arg * 2 ** low).to_i)
     end
 
+    # Properly encodes signed fixed-point numbers.
     def encode_fixed(arg, type)
       high, low = type.sub_type.split("x").map(&:to_i)
       raise ValueOutOfBounds, arg unless arg >= -2 ** (high - 1) and arg < 2 ** (high - 1)
@@ -328,23 +331,25 @@ module Eth
       return Util.zpad_int(i % 2 ** (high + low))
     end
 
+    # Properly encodes byte-strings.
     def encode_bytes(arg, type)
       raise EncodingError, "Expecting String: #{arg}" unless arg.instance_of? String
       if type.sub_type.empty?
         size = Util.zpad_int arg.size
-        padding = BYTE_ZERO * (Util.ceil32(arg.size) - arg.size)
+        padding = Constant::BYTE_ZERO * (Util.ceil32(arg.size) - arg.size)
 
         # variable length string/bytes
         return "#{size}#{arg}#{padding}"
       else
         raise ValueOutOfBounds, arg unless arg.size <= type.sub_type.to_i
-        padding = BYTE_ZERO * (32 - arg.size)
+        padding = Constant::BYTE_ZERO * (32 - arg.size)
 
         # fixed length string/bytes
         return "#{arg}#{padding}"
       end
     end
 
+    # Properly encodes hash-strings.
     def encode_hash(arg, type)
       size = type.sub_type.to_i
       raise EncodingError, "Argument too long: #{arg}" unless size > 0 and size <= 32
@@ -365,6 +370,7 @@ module Eth
       end
     end
 
+    # Properly encodes addresses.
     def encode_address(arg)
       if arg.is_a? Integer
 

data/lib/eth/address.rb

@@ -12,10 +12,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# Provides the `Eth` module.
+# Provides the {Eth} module.
 module Eth
 
-  # The `Eth::Address` class to handle checksummed Ethereum addresses.
+  # The {Eth::Address} class to handle checksummed Ethereum addresses.
   class Address
 
     # Provides a special checksum error if EIP-55 is violated.
@@ -24,7 +24,7 @@ module Eth
     # The prefixed and checksummed Ethereum address.
     attr_reader :address
 
-    # Constructor of the `Eth::Address` class. Creates a new hex
+    # Constructor of the {Eth::Address} class. Creates a new hex
     # prefixed address.
     #
     # @param address [String] hex string representing an ethereum address.
@@ -38,9 +38,9 @@ module Eth
       end
     end
 
-    # Check that the address is valid.
+    # Checks that the address is valid.
     #
-    # @return [Bool] true if valid address.
+    # @return [Boolean] true if valid address.
     def valid?
       if !matches_any_format?
         false
@@ -68,30 +68,37 @@ module Eth
 
     private
 
+    # Checks whether the address checksum matches.
     def checksum_matches?
       address == checksummed
     end
 
+    # Checks whether the address is not checksummed.
     def not_checksummed?
       all_uppercase? || all_lowercase?
     end
 
+    # Checks whether the address is all upper-case.
     def all_uppercase?
       address.match /(?:0[xX])[A-F0-9]{40}/
     end
 
+    # Checks whether the address is all lower-case.
     def all_lowercase?
       address.match /(?:0[xX])[a-f0-9]{40}/
     end
 
+    # Checks whether the address matches any known format.
     def matches_any_format?
       address.match /\A(?:0[xX])[a-fA-F0-9]{40}\z/
     end
 
+    # Computes the checksum of the address.
     def checksum
       Util.bin_to_hex Util.keccak256 unprefixed.downcase
     end
 
+    # Removes the hex prefix.
     def unprefixed
       Util.remove_hex_prefix address
     end