eth 0.5.0 → 0.5.1

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

data/lib/eth/client/ipc.rb

@@ -0,0 +1,47 @@
+# 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 "socket"
+
+# Provides the {Eth} module.
+module Eth
+
+  # Provides an IPC-RPC client.
+  class Client::Ipc < Client
+
+    # The path of the IPC socket.
+    attr_accessor :path
+
+    # Constructor for the IPC Client. Should not be used; use
+    # {Client.create} intead.
+    #
+    # @param path [String] an URI pointing to an IPC RPC-API.
+    def initialize(path)
+      super
+      @path = path
+    end
+
+    # Sends an RPC request to the connected IPC socket.
+    #
+    # @param payload [Hash] the RPC request parameters.
+    # @return [String] a JSON-encoded response.
+    def send(payload)
+      socket = UNIXSocket.new(@path)
+      socket.puts(payload)
+      read = socket.recvmsg(nil)[0]
+      socket.close
+      return read
+    end
+  end
+end

data/lib/eth/client.rb

@@ -0,0 +1,232 @@
+# 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::Client} super-class to connect to Ethereum
+  # network's RPC-API endpoints (IPC or HTTP).
+  class Client
+
+    # The client's RPC-request ID starting at 0.
+    attr_reader :id
+
+    # The connected network's chain ID.
+    attr_reader :chain_id
+
+    # The connected network's client coinbase.
+    attr_accessor :default_account
+
+    # The default transaction max priority fee per gas in Wei.
+    attr_accessor :max_priority_fee_per_gas
+
+    # The default transaction max fee per gas in Wei.
+    attr_accessor :max_fee_per_gas
+
+    # The default gas limit for the transaction.
+    attr_accessor :gas_limit
+
+    # Creates a new RPC-Client, either by providing an HTTP/S host or
+    # an IPC path.
+    #
+    # @param host [String] either an HTTP/S host or an IPC path.
+    # @return [Eth::Client::Ipc] an IPC client.
+    # @return [Eth::Client::Http] an HTTP client.
+    # @raise [ArgumentError] in case it cannot determine the client type.
+    def self.create(host)
+      return Client::Ipc.new host if host.end_with? ".ipc"
+      return Client::Http.new host if host.start_with? "http"
+      raise ArgumentError, "Unable to detect client type!"
+    end
+
+    # Constructor for the {Eth::Client} super-class. Should not be used;
+    # use {Client.create} intead.
+    def initialize(_)
+      @id = 0
+      @max_priority_fee_per_gas = 0
+      @max_fee_per_gas = Tx::DEFAULT_GAS_PRICE
+      @gas_limit = Tx::DEFAULT_GAS_LIMIT
+    end
+
+    # Gets the default account (coinbase) of the connected client.
+    #
+    # @return [Eth::Address] the coinbase account address.
+    def default_account
+      @default_account ||= Address.new eth_coinbase["result"]
+    end
+
+    # Gets the chain ID of the connected network.
+    #
+    # @return [Integer] the chain ID.
+    def chain_id
+      @chain_id ||= eth_chain_id["result"].to_i 16
+    end
+
+    # Gets the balance for an address.
+    #
+    # @param address [Eth::Address] the address to get the balance for.
+    # @return [Integer] the balance in Wei.
+    def get_balance(address)
+      eth_get_balance(address)["result"].to_i 16
+    end
+
+    # Gets the next nonce for an address used to draft new transactions.
+    #
+    # @param address [Eth::Address] the address to get the nonce for.
+    # @return [Integer] the next nonce to be used.
+    def get_nonce(address)
+      eth_get_transaction_count(address, "pending")["result"].to_i 16
+    end
+
+    # Simply transfer Ether to an account and waits for it to be mined.
+    # Uses `eth_coinbase` and external signer if no  sender key is
+    # provided.
+    #
+    # @param destination [Eth::Address] the destination address.
+    # @param amount [Integer] the transfer amount in Wei.
+    # @param sender_key [Eth::Key] the sender private key.
+    # @param legacy [Boolean] enables legacy transactions (pre-EIP-1559).
+    # @return [String] the transaction hash.
+    def transfer_and_wait(destination, amount, sender_key = nil, legacy = false)
+      wait_for_tx(transfer(destination, amount, sender_key, legacy))
+    end
+
+    # Simply transfer Ether to an account without any call data or
+    # access lists attached. Uses `eth_coinbase` and external signer
+    # if no sender key is provided.
+    #
+    # @param destination [Eth::Address] the destination address.
+    # @param amount [Integer] the transfer amount in Wei.
+    # @param sender_key [Eth::Key] the sender private key.
+    # @param legacy [Boolean] enables legacy transactions (pre-EIP-1559).
+    # @return [String] the transaction hash.
+    def transfer(destination, amount, sender_key = nil, legacy = false)
+      params = {
+        value: amount,
+        to: destination,
+        gas_limit: gas_limit,
+        chain_id: chain_id,
+      }
+      if legacy
+        params.merge!({
+          gas_price: max_fee_per_gas,
+        })
+      else
+        params.merge!({
+          priority_fee: max_priority_fee_per_gas,
+          max_gas_fee: max_fee_per_gas,
+        })
+      end
+      unless sender_key.nil?
+
+        # use the provided key as sender and signer
+        params.merge!({
+          from: sender_key.address,
+          nonce: get_nonce(sender_key.address),
+        })
+        tx = Eth::Tx.new(params)
+        tx.sign sender_key
+        return eth_send_raw_transaction(tx.hex)["result"]
+      else
+
+        # use the default account as sender and external signer
+        params.merge!({
+          from: default_account,
+          nonce: get_nonce(default_account),
+        })
+        return eth_send_transaction(params)["result"]
+      end
+    end
+
+    # Gives control over resetting the RPC request ID back to zero.
+    # Usually not needed.
+    #
+    # @return [Integer] 0
+    def reset_id
+      @id = 0
+    end
+
+    # Checkes wether a transaction is mined or not.
+    #
+    # @param hash [String] the transaction hash.
+    # @return [Boolean] true if included in a block.
+    def is_mined_tx?(hash)
+      mined_tx = eth_get_transaction_by_hash hash
+      !mined_tx.nil? && !mined_tx["result"].nil? && !mined_tx["result"]["blockNumber"].nil?
+    end
+
+    # Waits for an transaction to be mined by the connected chain.
+    #
+    # @param hash [String] the transaction hash.
+    # @return [String] the transactin hash once the transaction is mined.
+    # @raise [Timeout::Error] if it's not mined within 5 minutes.
+    def wait_for_tx(hash)
+      start_time = Time.now
+      timeout = 300
+      retry_rate = 0.1
+      loop do
+        raise Timeout::Error if ((Time.now - start_time) > timeout)
+        return hash if is_mined_tx? hash
+        sleep retry_rate
+      end
+    end
+
+    # Metafunction to provide all known RPC commands defined in
+    # Eth::Api as snake_case methods to the Eth::Client classes.
+    Api::COMMANDS.each do |cmd|
+      method_name = cmd.gsub(/([a-z\d])([A-Z])/, '\1_\2').downcase
+      define_method method_name do |*args|
+        send_command cmd, args
+      end
+    end
+
+    private
+
+    # Prepares parameters and sends the command to the client.
+    def send_command(command, args)
+      args << "latest" if ["eth_getBalance", "eth_call"].include? command
+      payload = {
+        jsonrpc: "2.0",
+        method: command,
+        params: marshal(args),
+        id: next_id,
+      }
+      output = JSON.parse(send(payload.to_json))
+      raise IOError, output["error"]["message"] unless output["error"].nil?
+      return output
+    end
+
+    # Increments the request id.
+    def next_id
+      @id += 1
+    end
+
+    # Recursively marshals all request parameters.
+    def marshal(params)
+      if params.is_a? Array
+        return params.map! { |param| marshal(param) }
+      elsif params.is_a? Hash
+        return params.transform_values! { |param| marshal(param) }
+      elsif params.is_a? Numeric
+        return Util.prefix_hex "#{params.to_i.to_s(16)}"
+      elsif params.is_a? Address
+        return params.to_s
+      elsif Util.is_hex? params
+        return Util.prefix_hex params
+      else
+        return params
+      end
+    end
+  end
+end