eth: some docs and cleanups (#108)

lib/eth.rb

@@ -23,14 +23,7 @@ module Eth
 require "eth/chain"
 require "eth/constant"
 require "eth/contract"
-require "eth/contract/event"
-require "eth/contract/function"
-require "eth/contract/function_input"
-require "eth/contract/function_output"
-require "eth/contract/initializer"
 require "eth/client"
-require "eth/client/http"
-require "eth/client/ipc"
 require "eth/eip712"
 require "eth/key"
 require "eth/rlp"

lib/eth/chain.rb

@@ -41,6 +41,9 @@ class ReplayProtectionError < StandardError; end
     # Chain ID for Gnosis mainnet.
     XDAI = 100.freeze
 
+    # Chain ID for the Polygon Matic mainnet.
+    MATIC = 137.freeze
+
     # Chain ID for Arbitrum mainnet.
     ARBITRUM = 42161.freeze
 
@@ -77,6 +80,9 @@ class ReplayProtectionError < StandardError; end
     # Chain ID for Optimistic Goerli testnet.
     GOERLI_OPTIMISM = 420.freeze
 
+    # Chain ID for the Polygon Mumbai testnet.
+    MUMBAI = 80001.freeze
+
     # Chain ID for Arbitrum Rinkeby testnet.
     RINKEBY_ARBITRUM = 421611.freeze
 
@@ -85,8 +91,6 @@ class ReplayProtectionError < StandardError; end
 
     # Chain ID for the geth private network preset.
     PRIVATE_GETH = 1337.freeze
-    MATIC = 137.freeze
-    MUMBAI = 80001.freeze
 
     # Indicates wether the given `v` indicates a legacy chain value
     # without EIP-155 replay protection.

lib/eth/client.rb

@@ -203,7 +203,7 @@ def deploy(contract, *args, **kwargs)
         })
       end
       unless kwargs[:sender_key].nil?
-        # use the provided key as sender and signer
+        # Uses the provided key as sender and signer
         params.merge!({
           from: kwargs[:sender_key].address,
           nonce: get_nonce(kwargs[:sender_key].address),
@@ -212,7 +212,7 @@ def deploy(contract, *args, **kwargs)
         tx.sign kwargs[:sender_key]
         return eth_send_raw_transaction(tx.hex)["result"]
       else
-        # use the default account as sender and external signer
+        # Uses the default account as sender and external signer
         params.merge!({
           from: default_account,
           nonce: get_nonce(default_account),
@@ -413,7 +413,7 @@ def call_raw(contract, func, *args, **kwargs)
         })
       end
       unless kwargs[:sender_key].nil?
-        # use the provided key as sender and signer
+        # Uses the provided key as sender and signer
         params.merge!({
           from: kwargs[:sender_key].address,
           nonce: get_nonce(kwargs[:sender_key].address),
@@ -477,3 +477,7 @@ def marshal(params)
     end
   end
 end
+
+# Load the client/* libraries
+require "eth/client/http"
+require "eth/client/ipc"

lib/eth/contract.rb

@@ -134,3 +134,10 @@ def parse_abi(abi)
     end
   end
 end
+
+# Load the contract/* libraries
+require "eth/contract/event"
+require "eth/contract/function"
+require "eth/contract/function_input"
+require "eth/contract/function_output"
+require "eth/contract/initializer"

lib/eth/contract/event.rb

@@ -16,6 +16,7 @@
 
 # Provides the {Eth} module.
 module Eth
+
   # Provide classes for contract event.
   class Contract::Event
     attr_accessor :name, :signature, :input_types, :inputs, :event_string, :address

lib/eth/contract/function.rb

@@ -16,6 +16,7 @@
 
 # Provides the {Eth} module.
 module Eth
+
   # Provides the methods for smart contract function.
   class Contract::Function
     attr_accessor :name, :inputs, :outputs, :signature, :constant, :function_string
@@ -36,7 +37,7 @@ def initialize(data)
       @signature = self.class.encoded_function_signature(@function_string)
     end
 
-    # Create function strings.
+    # Creates function strings.
     #
     # @param name [String] function name.
     # @param inputs [Array<Eth::Contract::FunctionInput>] function input class list.
@@ -45,12 +46,12 @@ def self.calc_signature(name, inputs)
       "#{name}(#{inputs.collect { |x| x.type }.join(",")})"
     end
 
-    # encode function signature.
+    # Encodes a function signature.
     #
     # @param signature [String] function signature.
     # @return [String] encoded function signature string.
     def self.encoded_function_signature(signature)
-      Digest::Keccak.hexdigest(signature, 256)[0..7]
+      Util.bin_to_hex Util.keccak256(signature)[0..3]
     end
   end
 end

lib/eth/contract/function_input.rb

@@ -16,6 +16,7 @@
 
 # Provides the {Eth} module.
 module Eth
+
   # Provide classes for contract function input.
   class Contract::FunctionInput
     attr_accessor :type, :name
@@ -28,7 +29,7 @@ def initialize(data)
       @name = data["name"]
     end
 
-    # Returns types like uint256
+    # Returns complete types with subtypes, e.g., `uint256`.
     def type
       @type.base_type + @type.sub_type
     end

lib/eth/contract/function_output.rb

@@ -16,15 +16,20 @@
 
 # Provides the {Eth} module.
 module Eth
+
   # Provide classes for contract function output.
   class Contract::FunctionOutput
     attr_accessor :type, :name
 
+    # Constructor of the {Eth::Contract::FunctionOutput} class.
+    #
+    # @param data [Hash] contract abi data.
     def initialize(data)
       @type = Eth::Abi::Type.parse(data["type"])
       @name = data["name"]
     end
 
+    # Returns complete types with subtypes, e.g., `uint256`.
     def type
       @type.base_type + @type.sub_type
     end

lib/eth/contract/initializer.rb

@@ -16,6 +16,7 @@
 
 # Provides the {Eth} module.
 module Eth
+
   # Provide classes for contract initializer.
   class Contract::Initializer
     attr_accessor :contracts, :file
@@ -36,7 +37,7 @@ def initialize(file)
       end
     end
 
-    # Build and return all contracts.
+    # Builds and returns all contracts.
     def build_all
       @contracts.each do |contract|
         contract.build