eth 0.5.0 → 0.5.3

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,16 @@
 
 require "konstructor"
 
-require "eth/abi/constant"
+require "eth/abi/event"
 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 +70,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 +79,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 +112,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,41 +285,57 @@ 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
     end
 
+    # Build event signature string from ABI interface.
+    #
+    # @param interface [Hash] ABI event interface.
+    # @return [String] interface signature string.
+    def signature(interface)
+      name = interface.fetch("name")
+      inputs = interface.fetch("inputs", [])
+      types = inputs.map { |i| i.fetch("type") }
+      "#{name}(#{types.join(",")})"
+    end
+
     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 +343,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 +382,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

data/lib/eth/api.rb

@@ -0,0 +1,223 @@
+# Copyright (c) 2016-2022 The Ruby-Eth Contributors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Provides the {Eth} module.
+module Eth
+
+  # Provides the `Eth::Api` module grouping known RPC commands.
+  module Api
+
+    # Implements the available RPC-APIs provided by Geth version 1.10.15.
+    COMMANDS = [
+      "admin_addPeer",
+      "admin_addTrustedPeer",
+      "admin_clearHistory",
+      "admin_datadir",
+      "admin_exportChain",
+      "admin_getDatadir",
+      "admin_getNodeInfo",
+      "admin_getPeers",
+      "admin_importChain",
+      "admin_nodeInfo",
+      "admin_peers",
+      "admin_removePeer",
+      "admin_removeTrustedPeer",
+      "admin_sleep",
+      "admin_sleepBlocks",
+      "admin_startHTTP",
+      "admin_startRPC",
+      "admin_startWS",
+      "admin_stopHTTP",
+      "admin_stopRPC",
+      "admin_stopWS",
+      "clique_discard",
+      "clique_getProposals",
+      "clique_getSigner",
+      "clique_getSigners",
+      "clique_getSignersAtHash",
+      "clique_getSnapshot",
+      "clique_getSnapshotAtHash",
+      "clique_proposals",
+      "clique_propose",
+      "clique_status",
+      "debug_accountRange",
+      "debug_backtraceAt",
+      "debug_blockProfile",
+      "debug_chaindbCompact",
+      "debug_chaindbProperty",
+      "debug_cpuProfile",
+      "debug_dumpBlock",
+      "debug_freeOSMemory",
+      "debug_freezeClient",
+      "debug_gcStats",
+      "debug_getAccessibleState",
+      "debug_getBadBlocks",
+      "debug_getBlockRlp",
+      "debug_getHeaderRlp",
+      "debug_getModifiedAccountsByHash",
+      "debug_getModifiedAccountsByNumber",
+      "debug_goTrace",
+      "debug_intermediateRoots",
+      "debug_memStats",
+      "debug_mutexProfile",
+      "debug_preimage",
+      "debug_printBlock",
+      "debug_seedHash",
+      "debug_setBlockProfileRate",
+      "debug_setGCPercent",
+      "debug_setHead",
+      "debug_setMutexProfileFraction",
+      "debug_stacks",
+      "debug_standardTraceBadBlockToFile",
+      "debug_standardTraceBlockToFile",
+      "debug_startCPUProfile",
+      "debug_startGoTrace",
+      "debug_stopCPUProfile",
+      "debug_stopGoTrace",
+      "debug_storageRangeAt",
+      "debug_testSignCliqueBlock",
+      "debug_traceBadBlock",
+      "debug_traceBlock",
+      "debug_traceBlockByHash",
+      "debug_traceBlockByNumber",
+      "debug_traceBlockFromFile",
+      "debug_traceCall",
+      "debug_traceTransaction",
+      "debug_verbosity",
+      "debug_vmodule",
+      "debug_writeBlockProfile",
+      "debug_writeMemProfile",
+      "debug_writeMutexProfile",
+      "eth_accounts",
+      "eth_blockNumber",
+      "eth_call",
+      "eth_chainId",
+      "eth_coinbase",
+      "eth_compile",
+      "eth_contract",
+      "eth_createAccessList",
+      "eth_defaultAccount",
+      "eth_defaultBlock",
+      "eth_estimateGas",
+      "eth_feeHistory",
+      "eth_fillTransaction",
+      "eth_filter",
+      "eth_gasPrice",
+      "eth_getAccounts",
+      "eth_getBalance",
+      "eth_getBlock",
+      "eth_getBlockByHash",
+      "eth_getBlockByNumber",
+      "eth_getBlockNumber",
+      "eth_getBlockTransactionCount",
+      "eth_getBlockTransactionCountByHash",
+      "eth_getBlockTransactionCountByNumber",
+      "eth_getBlockUncleCount",
+      "eth_getCode",
+      "eth_getCoinbase",
+      "eth_getCompilers",
+      "eth_getFilterChanges",
+      "eth_getFilterLogs",
+      "eth_getGasPrice",
+      "eth_getHashrate",
+      "eth_getHeaderByHash",
+      "eth_getHeaderByNumber",
+      "eth_getLogs",
+      "eth_getMaxPriorityFeePerGas",
+      "eth_getMining",
+      "eth_getPendingTransactions",
+      "eth_getProof",
+      "eth_getProtocolVersion",
+      "eth_getRawTransaction",
+      "eth_getRawTransactionFromBlock",
+      "eth_getStorageAt",
+      "eth_getSyncing",
+      "eth_getTransaction",
+      "eth_getTransactionByBlockHashAndIndex",
+      "eth_getTransactionByBlockNumberAndIndex",
+      "eth_getTransactionByHash",
+      "eth_getTransactionCount",
+      "eth_getTransactionFromBlock",
+      "eth_getTransactionReceipt",
+      "eth_getUncle",
+      "eth_getUncleCountByBlockHash",
+      "eth_getUncleCountByBlockNumber",
+      "eth_getWork",
+      "eth_hashrate",
+      "eth_iban",
+      "eth_icapNamereg",
+      "eth_isSyncing",
+      "eth_maxPriorityFeePerGas",
+      "eth_mining",
+      "eth_namereg",
+      "eth_newBlockFilter",
+      "eth_newFilter",
+      "eth_newPendingTransactionFilter",
+      "eth_pendingTransactions",
+      "eth_protocolVersion",
+      "eth_resend",
+      "eth_sendIBANTransaction",
+      "eth_sendRawTransaction",
+      "eth_sendTransaction",
+      "eth_sign",
+      "eth_signTransaction",
+      "eth_submitHashrate",
+      "eth_submitTransaction",
+      "eth_submitWork",
+      "eth_subscribe",
+      "eth_syncing",
+      "eth_uninstallFilter",
+      "eth_unsubscribe",
+      "les_addBalance",
+      "les_clientInfo",
+      "les_getCheckpoint",
+      "les_getCheckpointContractAddress",
+      "les_latestCheckpoint",
+      "les_priorityClientInfo",
+      "les_serverInfo",
+      "les_setClientParams",
+      "les_setDefaultParams",
+      "miner_getHashrate",
+      "miner_setEtherbase",
+      "miner_setExtra",
+      "miner_setGasLimit",
+      "miner_setGasPrice",
+      "miner_start",
+      "miner_stop",
+      "personal_deriveAccount",
+      "personal_ecRecover",
+      "personal_getListAccounts",
+      "personal_getListWallets",
+      "personal_importRawKey",
+      "personal_initializeWallet",
+      "personal_listAccounts",
+      "personal_listWallets",
+      "personal_lockAccount",
+      "personal_newAccount",
+      "personal_openWallet",
+      "personal_sendTransaction",
+      "personal_sign",
+      "personal_signTransaction",
+      "personal_unlockAccount",
+      "personal_unpair",
+      "txpool_content",
+      "txpool_contentFrom",
+      "txpool_getContent",
+      "txpool_getInspect",
+      "txpool_getStatus",
+      "txpool_inspect",
+      "txpool_status",
+    ]
+  end
+end

data/lib/eth/chain.rb

@@ -12,82 +12,85 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# Provides the `Eth` module.
+# Provides the {Eth} module.
 module Eth
 
-  # Encapsulates `Chain` IDs and utilities for EIP-155 compatibility.
-  # ref: https://eips.ethereum.org/EIPS/eip-155
+  # Encapsulates {Eth::Chain} IDs and utilities for EIP-155 compatibility.
+  # Ref: https://eips.ethereum.org/EIPS/eip-155
   module Chain
     extend self
 
     # Provides a special replay protection error if EIP-155 is violated.
     class ReplayProtectionError < StandardError; end
 
-    # Chain ID for Ethereum mainnet
+    # Chain ID for Ethereum mainnet.
     ETHEREUM = 1.freeze
 
-    # Chain ID for Expanse mainnet
+    # Chain ID for Expanse mainnet.
     EXPANSE = 2.freeze
 
-    # Chain ID for Optimistic Ethereum mainnet
+    # Chain ID for Optimistic Ethereum mainnet.
     OPTIMISM = 10.freeze
 
-    # Chain ID for Ethereum Classic mainnet
+    # Chain ID for Ethereum Classic mainnet.
     CLASSIC = 61.freeze
 
-    # Chain ID for POA Network mainnet
+    # Chain ID for POA Network mainnet.
     POA_NET = 99.freeze
 
-    # Chain ID for xDAI mainnet
+    # Chain ID for Gnosis mainnet.
     XDAI = 100.freeze
 
-    # Chain ID for Arbitrum mainnet
+    # Chain ID for Arbitrum mainnet.
     ARBITRUM = 42161.freeze
 
-    # Chain ID for Morden (Ethereum) testnet
+    # Chain ID for Morden (Ethereum) testnet.
     MORDEN = 2.freeze
 
-    # Chain ID for Ropsten testnet
+    # Chain ID for Ropsten testnet.
     ROPSTEN = 3.freeze
 
-    # Chain ID for Rinkeby testnet
+    # Chain ID for Rinkeby testnet.
     RINKEBY = 4.freeze
 
-    # Chain ID for Goerli testnet
+    # Chain ID for Goerli testnet.
     GOERLI = 5.freeze
 
-    # Chain ID for Kotti testnet
+    # Chain ID for Kotti testnet.
     KOTTI = 6.freeze
 
-    # Chain ID for Kovan testnet
+    # Chain ID for Kovan testnet.
     KOVAN = 42.freeze
 
-    # Chain ID for Morden (Classic) testnet
+    # Chain ID for Morden (Classic) testnet.
     MORDEN_CLASSIC = 62.freeze
 
-    # Chain ID for Mordor testnet
+    # Chain ID for Mordor testnet.
     MORDOR = 63.freeze
 
-    # Chain ID for Optimistik Kovan testnet
+    # Chain ID for Optimistik Kovan testnet.
     KOVAN_OPTIMISM = 69.freeze
 
-    # Chain ID for Arbitrum xDAI testnet
+    # Chain ID for Arbitrum xDAI testnet.
     XDAI_ARBITRUM = 200.freeze
 
-    # Chain ID for Optimistic Goerli testnet
+    # Chain ID for Optimistic Goerli testnet.
     GOERLI_OPTIMISM = 420.freeze
 
-    # Chain ID for Arbitrum Rinkeby testnet
+    # Chain ID for Arbitrum Rinkeby testnet.
     RINKEBY_ARBITRUM = 421611.freeze
 
-    # Chain ID for the geth private network preset
+    # Chain ID for Sepolia testnet.
+    SEPOLIA = 11155111.freeze
+
+    # Chain ID for the geth private network preset.
     PRIVATE_GETH = 1337.freeze
 
     # Indicates wether the given `v` indicates a legacy chain value
     # without EIP-155 replay protection.
     #
-    # @param v [Integer] the signature's `v` value
-    # @return [Boolean] true if legacy value
+    # @param v [Integer] the signature's `v` value.
+    # @return [Boolean] true if legacy value.
     def is_legacy?(v)
       [27, 28].include? v
     end
@@ -95,7 +98,7 @@ module Eth
     # Convert a given `v` value to an ECDSA recovery id for the given
     # EIP-155 chain ID.
     #
-    # @param v [Integer] the signature's `v` value
+    # @param v [Integer] the signature's `v` value.
     # @param chain_id [Integer] the chain id the signature was generated on.
     # @return [Integer] the recovery id corresponding to `v`.
     # @raise [ReplayProtectionError] if the given `v` is invalid.
@@ -134,10 +137,10 @@ module Eth
     end
 
     # Converst a `v` value into a chain ID. This does not work for legacy signatures
-    # with v < 36 that do not conform with EIP-155.
+    # with `v < 36` that do not conform with EIP-155.
     #
     # @param v [Integer] the signature's `v` value.
-    # @return [Integer] the chain id as per EIP-155 or nil if there is no replay protection.
+    # @return [Integer] the chain id as per EIP-155 or `nil` if there is no replay protection.
     def to_chain_id(v)
       return nil if v < 36
       chain_id = (v - 35) / 2

data/lib/eth/client/http.rb

@@ -0,0 +1,63 @@
+# Copyright (c) 2016-2022 The Ruby-Eth Contributors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require "net/http"
+
+# Provides the {Eth} module.
+module Eth
+
+  # Provides an HTTP/S-RPC client.
+  class Client::Http < Client
+
+    # The host of the HTTP endpoint.
+    attr_reader :host
+
+    # The port of the HTTP endpoint.
+    attr_reader :port
+
+    # The full URI of the HTTP endpoint, including path.
+    attr_reader :uri
+
+    # Attribute indicator for SSL.
+    attr_reader :ssl
+
+    # Constructor for the HTTP Client. Should not be used; use
+    # {Client.create} intead.
+    #
+    # @param host [String] an URI pointing to an HTTP RPC-API.
+    def initialize(host)
+      super
+      uri = URI.parse(host)
+      raise ArgumentError, "Unable to parse the HTTP-URI!" unless ["http", "https"].include? uri.scheme
+      @host = uri.host
+      @port = uri.port
+      @ssl = uri.scheme == "https"
+      @uri = URI("#{uri.scheme}://#{@host}:#{@port}#{uri.path}")
+    end
+
+    # Sends an RPC request to the connected HTTP client.
+    #
+    # @param payload [Hash] the RPC request parameters.
+    # @return [String] a JSON-encoded response.
+    def send(payload)
+      http = Net::HTTP.new(@host, @port)
+      http.use_ssl = @ssl
+      header = { "Content-Type" => "application/json" }
+      request = Net::HTTP::Post.new(@uri, header)
+      request.body = payload
+      response = http.request(request)
+      response.body
+    end
+  end
+end