eth 0.4.16 → 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

@@ -0,0 +1,151 @@
+# 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
+
+  # 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.
+    ETHEREUM = 1.freeze
+
+    # Chain ID for Expanse mainnet.
+    EXPANSE = 2.freeze
+
+    # Chain ID for Optimistic Ethereum mainnet.
+    OPTIMISM = 10.freeze
+
+    # Chain ID for Ethereum Classic mainnet.
+    CLASSIC = 61.freeze
+
+    # Chain ID for POA Network mainnet.
+    POA_NET = 99.freeze
+
+    # Chain ID for Gnosis mainnet.
+    XDAI = 100.freeze
+
+    # Chain ID for Arbitrum mainnet.
+    ARBITRUM = 42161.freeze
+
+    # Chain ID for Morden (Ethereum) testnet.
+    MORDEN = 2.freeze
+
+    # Chain ID for Ropsten testnet.
+    ROPSTEN = 3.freeze
+
+    # Chain ID for Rinkeby testnet.
+    RINKEBY = 4.freeze
+
+    # Chain ID for Goerli testnet.
+    GOERLI = 5.freeze
+
+    # Chain ID for Kotti testnet.
+    KOTTI = 6.freeze
+
+    # Chain ID for Kovan testnet.
+    KOVAN = 42.freeze
+
+    # Chain ID for Morden (Classic) testnet.
+    MORDEN_CLASSIC = 62.freeze
+
+    # Chain ID for Mordor testnet.
+    MORDOR = 63.freeze
+
+    # Chain ID for Optimistik Kovan testnet.
+    KOVAN_OPTIMISM = 69.freeze
+
+    # Chain ID for Arbitrum xDAI testnet.
+    XDAI_ARBITRUM = 200.freeze
+
+    # Chain ID for Optimistic Goerli testnet.
+    GOERLI_OPTIMISM = 420.freeze
+
+    # Chain ID for Arbitrum Rinkeby testnet.
+    RINKEBY_ARBITRUM = 421611.freeze
+
+    # 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.
+    def is_legacy?(v)
+      [27, 28].include? v
+    end
+
+    # 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 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.
+    def to_recovery_id(v, chain_id = ETHEREUM)
+      e = 0 + 2 * chain_id + 35
+      i = 1 + 2 * chain_id + 35
+      if [0, 1].include? v
+
+        # some wallets are using a `v` of 0 or 1 (ledger)
+        return v
+      elsif is_legacy? v
+
+        # this is the pre-EIP-155 legacy case
+        return v - 27
+      elsif [e, i].include? v
+
+        # this is the EIP-155 case
+        return v - 35 - 2 * chain_id
+      else
+        raise ReplayProtectionError, "Invalid v #{v} value for chain ID #{chain_id}. Invalid chain ID?"
+      end
+    end
+
+    # Converts a recovery ID into the expected `v` on a given chain.
+    #
+    # @param recovery_id [Integer] signature recovery id.
+    # @param chain_id [Integer] the chain id the signature was generated on.
+    # @return [Integer] the signature's `v` value.
+    def to_v(recovery_id, chain_id = nil)
+      if chain_id.nil? or chain_id < 1
+        v = 27 + recovery_id
+      else
+        v = 2 * chain_id + 35 + recovery_id
+      end
+      return v
+    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.
+    #
+    # @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.
+    def to_chain_id(v)
+      return nil if v < 36
+      chain_id = (v - 35) / 2
+      return nil if chain_id < 1
+      return chain_id
+    end
+  end
+end

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