eth 0.5.10 → 0.5.11

data/lib/eth/client/ipc.rb

@@ -24,7 +24,7 @@ module Eth
     attr_accessor :path
 
     # Constructor for the IPC Client. Should not be used; use
-    # {Client.create} intead.
+    # {Client.create} instead.
     #
     # @param path [String] an URI pointing to an IPC RPC-API.
     def initialize(path)
@@ -36,7 +36,7 @@ module Eth
     #
     # @param payload [Hash] the RPC request parameters.
     # @return [String] a JSON-encoded response.
-    def send(payload)
+    def send_request(payload)
       socket = UNIXSocket.new(@path)
       socket.puts(payload)
       read = socket.recvmsg(nil)[0]

data/lib/eth/client.rb

@@ -34,28 +34,22 @@ module Eth
     # The default transaction max fee per gas in Wei, defaults to {Tx::DEFAULT_GAS_PRICE}.
     attr_accessor :max_fee_per_gas
 
-    # The default gas limit for the transaction, defaults to {Tx::DEFAULT_GAS_LIMIT}.
-    attr_accessor :gas_limit
-
     # A custom error type if a contract interaction fails.
     class ContractExecutionError < StandardError; end
 
     # Creates a new RPC-Client, either by providing an HTTP/S host or
     # an IPC path. Supports basic authentication with username and password.
     #
-    # **Note**, this sets the folling gas defaults: {Tx::DEFAULT_PRIORITY_FEE},
-    # {Tx::DEFAULT_GAS_PRICE}, and {Tx::DEFAULT_GAS_LIMIT}. Use
-    # {#max_priority_fee_per_gas}, {#max_fee_per_gas}, and {#gas_limit} to set
-    # custom values prior to submitting transactions.
+    # **Note**, this sets the folling gas defaults: {Tx::DEFAULT_PRIORITY_FEE}
+    # and {Tx::DEFAULT_GAS_PRICE. Use {#max_priority_fee_per_gas} and
+    # {#max_fee_per_gas} to set custom values prior to submitting transactions.
     #
     # @param host [String] either an HTTP/S host or an IPC path.
     # @return [Eth::Client::Ipc] an IPC client.
-    # @return [Eth::Client::HttpAuth] an HTTP client with basic authentication.
     # @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::HttpAuth.new host if Regexp.new(":.*@.*:", Regexp::IGNORECASE).match host
       return Client::Http.new host if host.start_with? "http"
       raise ArgumentError, "Unable to detect client type!"
     end
@@ -66,7 +60,6 @@ module Eth
       @id = 0
       @max_priority_fee_per_gas = Tx::DEFAULT_PRIORITY_FEE
       @max_fee_per_gas = Tx::DEFAULT_GAS_PRICE
-      @gas_limit = Tx::DEFAULT_GAS_LIMIT
     end
 
     # Gets the default account (coinbase) of the connected client.
@@ -76,7 +69,7 @@ module Eth
     #
     # @return [Eth::Address] the coinbase account address.
     def default_account
-      raise ArgumentError, "The default account is not available on remote connections!" unless local?
+      raise ArgumentError, "The default account is not available on remote connections!" unless local? || @default_account
       @default_account ||= Address.new eth_coinbase["result"]
     end
 
@@ -146,41 +139,10 @@ module Eth
       params = {
         value: amount,
         to: destination,
-        gas_limit: gas_limit,
+        gas_limit: Tx::DEFAULT_GAS_LIMIT,
         chain_id: chain_id,
       }
-      if kwargs[: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 kwargs[:sender_key].nil?
-
-        # use the provided key as sender and signer
-        params.merge!({
-          from: kwargs[:sender_key].address,
-          nonce: kwargs[:nonce] || get_nonce(kwargs[:sender_key].address),
-        })
-        tx = Eth::Tx.new(params)
-        tx.sign kwargs[:sender_key]
-        return eth_send_raw_transaction(tx.hex)["result"]
-      else
-
-        # we do not allow accessing accounts on remote connections
-        raise ArgumentError, "The default account is not available on remote connections, please provide a :sender_key!" unless local?
-
-        # use the default account as sender and external signer
-        params.merge!({
-          from: default_account,
-          nonce: kwargs[:nonce] || get_nonce(default_account),
-        })
-        return eth_send_transaction(params)["result"]
-      end
+      send_transaction(params, kwargs[:legacy], kwargs[:sender_key], kwargs[:nonce])
     end
 
     # Transfers a token that implements the ERC20 `transfer()` interface.
@@ -207,7 +169,7 @@ module Eth
     #   @param amount [Integer] the transfer amount (mind the `decimals()`).
     #   @param **sender_key [Eth::Key] the sender private key.
     #   @param **legacy [Boolean] enables legacy transactions (pre-EIP-1559).
-    #   @param **gas_limit [Integer] optional gas limit override for deploying the contract.
+    #   @param **gas_limit [Integer] optional gas limit override for the transfer.
     #   @param **nonce [Integer] optional specific nonce for transaction.
     #   @param **tx_value [Integer] optional transaction value field filling.
     # @return [Object] returns the result of the transaction.
@@ -266,37 +228,7 @@ module Eth
         chain_id: chain_id,
         data: data,
       }
-      if kwargs[: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 kwargs[:sender_key].nil?
-        # Uses the provided key as sender and signer
-        params.merge!({
-          from: kwargs[:sender_key].address,
-          nonce: kwargs[:nonce] || get_nonce(kwargs[:sender_key].address),
-        })
-        tx = Eth::Tx.new(params)
-        tx.sign kwargs[:sender_key]
-        return eth_send_raw_transaction(tx.hex)["result"]
-      else
-
-        # Does not allow accessing accounts on remote connections
-        raise ArgumentError, "The default account is not available on remote connections, please provide a :sender_key!" unless local?
-
-        # Uses the default account as sender and external signer
-        params.merge!({
-          from: default_account,
-          nonce: kwargs[:nonce] || get_nonce(default_account),
-        })
-        return eth_send_transaction(params)["result"]
-      end
+      send_transaction(params, kwargs[:legacy], kwargs[:sender_key], kwargs[:nonce])
     end
 
     # Calls a contract function without executing it
@@ -315,7 +247,6 @@ module Eth
     #   @param *args optional function arguments.
     #   @param **sender_key [Eth::Key] the sender private key.
     #   @param **legacy [Boolean] enables legacy transactions (pre-EIP-1559).
-    #   @param **gas_limit [Integer] optional gas limit override for deploying the contract.
     # @return [Object] returns the result of the call.
     def call(contract, function, *args, **kwargs)
       func = contract.functions.select { |func| func.name == function }
@@ -328,9 +259,9 @@ module Eth
       end
       output = call_raw(contract, selected_func, *args, **kwargs)
       if output&.length == 1
-        return output[0]
+        output[0]
       else
-        return output
+        output
       end
     end
 
@@ -354,7 +285,7 @@ module Eth
     #   @param **sender_key [Eth::Key] the sender private key.
     #   @param **legacy [Boolean] enables legacy transactions (pre-EIP-1559).
     #   @param **address [Eth::Address] contract address.
-    #   @param **gas_limit [Integer] optional gas limit override for deploying the contract.
+    #   @param **gas_limit [Integer] optional gas limit override for transacting with the contract.
     #   @param **nonce [Integer] optional specific nonce for transaction.
     #   @param **tx_value [Integer] optional transaction value field filling.
     # @return [Object] returns the result of the transaction.
@@ -362,7 +293,7 @@ module Eth
       gas_limit = if kwargs[:gas_limit]
           kwargs[:gas_limit]
         else
-          Tx.estimate_intrinsic_gas(contract.bin) + Tx::CREATE_GAS
+          Tx.estimate_intrinsic_gas(contract.bin)
         end
       fun = contract.functions.select { |func| func.name == function }[0]
       params = {
@@ -372,37 +303,7 @@ module Eth
         to: kwargs[:address] || contract.address,
         data: call_payload(fun, args),
       }
-      if kwargs[: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 kwargs[:sender_key].nil?
-        # use the provided key as sender and signer
-        params.merge!({
-          from: kwargs[:sender_key].address,
-          nonce: kwargs[:nonce] || get_nonce(kwargs[:sender_key].address),
-        })
-        tx = Eth::Tx.new(params)
-        tx.sign kwargs[:sender_key]
-        return eth_send_raw_transaction(tx.hex)["result"]
-      else
-
-        # do not allow accessing accounts on remote connections
-        raise ArgumentError, "The default account is not available on remote connections, please provide a :sender_key!" unless local?
-
-        # use the default account as sender and external signer
-        params.merge!({
-          from: default_account,
-          nonce: kwargs[:nonce] || get_nonce(default_account),
-        })
-        return eth_send_transaction(params)["result"]
-      end
+      send_transaction(params, kwargs[:legacy], kwargs[:sender_key], kwargs[:nonce])
     end
 
     # Executes a contract function with a transaction and waits for it
@@ -437,7 +338,7 @@ module Eth
       signature = Util.hex_to_bin signature if Util.hex? signature
       magic = Util.hex_to_bin magic if Util.hex? magic
       result = call(contract, "isValidSignature", hash, signature)
-      return result === magic
+      result === magic
     end
 
     # Gives control over resetting the RPC request ID back to zero.
@@ -496,11 +397,45 @@ module Eth
     # Allows to determine if we work with a local connectoin
     def local?
       if self.instance_of? Eth::Client::Ipc
-        return true
+        true
       elsif self.host === "127.0.0.1" || self.host === "localhost"
-        return true
+        true
       else
-        return false
+        false
+      end
+    end
+
+    # Prepares a transaction to be send for the given params.
+    def send_transaction(params, legacy, key, nonce)
+      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 key.nil?
+
+        # use the provided key as sender and signer
+        params.merge!({
+          from: key.address,
+          nonce: nonce || get_nonce(key.address),
+        })
+        tx = Eth::Tx.new(params)
+        tx.sign key
+        eth_send_raw_transaction(tx.hex)["result"]
+      else
+
+        # do not allow accessing accounts on remote connections
+        raise ArgumentError, "The default account is not available on remote connections, please provide a :sender_key!" unless local?
+
+        # use the default account as sender and external signer
+        params.merge!({
+          from: default_account,
+          nonce: nonce || get_nonce(default_account),
+        })
+        eth_send_transaction(params)["result"]
       end
     end
 
@@ -541,9 +476,9 @@ module Eth
         params: marshal(args),
         id: next_id,
       }
-      output = JSON.parse(send(payload.to_json))
+      output = JSON.parse(send_request(payload.to_json))
       raise IOError, output["error"]["message"] unless output["error"].nil?
-      return output
+      output
     end
 
     # Increments the request id.
@@ -564,18 +499,18 @@ module Eth
     def marshal(params)
       params = params.dup
       if params.is_a? Array
-        return params.map! { |param| marshal(param) }
+        params.map! { |param| marshal(param) }
       elsif params.is_a? Hash
         params = camelize!(params)
-        return params.transform_values! { |param| marshal(param) }
+        params.transform_values! { |param| marshal(param) }
       elsif params.is_a? Numeric
-        return Util.prefix_hex "#{params.to_i.to_s(16)}"
+        Util.prefix_hex "#{params.to_i.to_s(16)}"
       elsif params.is_a? Address
-        return params.to_s
+        params.to_s
       elsif Util.hex? params
-        return Util.prefix_hex params
+        Util.prefix_hex params
       else
-        return params
+        params
       end
     end
   end
@@ -583,5 +518,4 @@ end
 
 # Load the client/* libraries
 require "eth/client/http"
-require "eth/client/http_auth"
 require "eth/client/ipc"

data/lib/eth/contract.rb

@@ -14,6 +14,8 @@
 
 # -*- encoding : ascii-8bit -*-
 
+require "forwardable"
+
 # Provides the {Eth} module.
 module Eth
 
@@ -27,11 +29,19 @@ module Eth
 
     # Constructor of the {Eth::Contract} class.
     #
+    # **Note**, do not use this directly. Use
+    # {from_abi}, {from_bin}, or {from_file}!
+    #
     # @param name [String] contract name.
     # @param bin [String] contract bin string.
     # @param abi [String] contract abi string.
     def initialize(name, bin, abi)
-      @name = name
+
+      # The contract name will be the class name and needs title casing.
+      _name = name.dup
+      _name[0] = name[0].upcase
+
+      @name = _name
       @bin = bin
       @abi = abi
       @constructor_inputs, @functions, @events = parse_abi(abi)

data/lib/eth/solidity.rb

@@ -28,10 +28,12 @@ module Eth
 
     # Instantiates a Solidity `solc` system compiler binding that can be
     # used to compile Solidity contracts.
-    def initialize
+    #
+    # @param path [String] optional override of the solidity compiler path.
+    def initialize(path = nil)
 
-      # Currently only supports `solc`.
-      solc = get_compiler_path
+      # Currently only supports `solc`. Try to override with `path`.
+      solc = path || get_compiler_path
       raise SystemCallError, "Unable to find the solc compiler path!" if solc.nil?
       @compiler = solc
     end
@@ -43,9 +45,10 @@ module Eth
     def compile(contract)
       raise Errno::ENOENT, "Contract file not found: #{contract}" unless File.exist? contract
       flag_opt = "--optimize"
+      flag_ir = "--via-ir"
       flag_json = "--combined-json=bin,abi"
       path = File.realpath contract
-      output, error, status = Open3.capture3 @compiler, flag_opt, flag_json, path
+      output, error, status = Open3.capture3 @compiler, flag_opt, flag_ir, flag_json, path
       raise SystemCallError, "Unable to run solc compiler!" if status.exitstatus === 127
       raise CompilerError, error unless status.success?
       json = JSON.parse output

data/lib/eth/tx/eip1559.rb

@@ -186,11 +186,16 @@ module Eth
         # last but not least, set the type.
         @type = TYPE_1559
 
-        # recover sender address
-        v = Chain.to_v recovery_id, chain_id
-        public_key = Signature.recover(unsigned_hash, "#{r.rjust(64, "0")}#{s.rjust(64, "0")}#{v.to_s(16)}", chain_id)
-        address = Util.public_key_to_address(public_key).to_s
-        @sender = Tx.sanitize_address address
+        unless recovery_id.nil?
+          # recover sender address
+          v = Chain.to_v recovery_id, chain_id
+          public_key = Signature.recover(unsigned_hash, "#{r.rjust(64, "0")}#{s.rjust(64, "0")}#{v.to_s(16)}", chain_id)
+          address = Util.public_key_to_address(public_key).to_s
+          @sender = Tx.sanitize_address address
+        else
+          # keep the 'from' field blank
+          @sender = Tx.sanitize_address nil
+        end
       end
 
       # Creates an unsigned copy of a transaction payload.

data/lib/eth/tx/eip2930.rb

@@ -181,11 +181,16 @@ module Eth
         # last but not least, set the type.
         @type = TYPE_2930
 
-        # recover sender address
-        v = Chain.to_v recovery_id, chain_id
-        public_key = Signature.recover(unsigned_hash, "#{r.rjust(64, "0")}#{s.rjust(64, "0")}#{v.to_s(16)}", chain_id)
-        address = Util.public_key_to_address(public_key).to_s
-        @sender = Tx.sanitize_address address
+        unless recovery_id.nil?
+          # recover sender address
+          v = Chain.to_v recovery_id, chain_id
+          public_key = Signature.recover(unsigned_hash, "#{r.rjust(64, "0")}#{s.rjust(64, "0")}#{v.to_s(16)}", chain_id)
+          address = Util.public_key_to_address(public_key).to_s
+          @sender = Tx.sanitize_address address
+        else
+          # keep the 'from' field blank
+          @sender = Tx.sanitize_address nil
+        end
       end
 
       # Creates an unsigned copy of a transaction payload.

data/lib/eth/tx/legacy.rb

@@ -154,13 +154,11 @@ module Eth
         _set_signature(v, r, s)
 
         unless chain_id.nil?
-
           # recover sender address
           public_key = Signature.recover(unsigned_hash, "#{r.rjust(64, "0")}#{s.rjust(64, "0")}#{v}", chain_id)
           address = Util.public_key_to_address(public_key).to_s
           @sender = Tx.sanitize_address address
         else
-
           # keep the 'from' field blank
           @sender = Tx.sanitize_address nil
         end

data/lib/eth/tx.rb

@@ -51,6 +51,9 @@ module Eth
     # The calldata gas cost of a zero byte.
     COST_ZERO_BYTE = 4.freeze
 
+    # The initcode gas cost for each word (32 bytes).
+    COST_INITCODE_WORD = 2.freeze
+
     # The access list gas cost of a storage key as per EIP-2930.
     COST_STORAGE_KEY = 1_900.freeze
 
@@ -156,7 +159,7 @@ module Eth
     end
 
     # Estimates intrinsic gas for provided call data (EIP-2028) and
-    # access lists (EIP-2930).
+    # access lists (EIP-2930). Respects initcode word cost (EIP-3860).
     #
     # @param data [String] the call data.
     # @param list [Array] the access list.
@@ -173,6 +176,10 @@ module Eth
         # count non-zero bytes
         none = data.size - zero
         gas += none * COST_NON_ZERO_BYTE
+
+        # count "words" as per EIP-3860
+        word_count = (data.length.to_f / 32.0).ceil
+        gas += word_count * COST_INITCODE_WORD
       end
       unless list.nil? or list.empty?
         list.each do |entry|
@@ -187,7 +194,7 @@ module Eth
           end
         end
       end
-      return gas
+      return gas.to_i
     end
 
     # Validates the common transaction fields such as nonce, gas limit,

data/lib/eth/util.rb

@@ -28,6 +28,7 @@ module Eth
     # @return [Eth::Address] an Ethereum address.
     def public_key_to_address(str)
       str = hex_to_bin str if hex? str
+      str = Secp256k1::PublicKey.from_data(str).uncompressed
       bytes = keccak256(str[1..-1])[-20..-1]
       Address.new bin_to_prefixed_hex bytes
     end

data/lib/eth/version.rb

@@ -15,6 +15,15 @@
 # Provides the {Eth} module.
 module Eth
 
-  # Defines the version of the {Eth} module.
-  VERSION = "0.5.10".freeze
+  # Defines the major version of the {Eth} module.
+  MAJOR = 0.freeze
+
+  # Defines the minor version of the {Eth} module.
+  MINOR = 5.freeze
+
+  # Defines the patch version of the {Eth} module.
+  PATCH = 11.freeze
+
+  # Defines the version string of the {Eth} module.
+  VERSION = [MAJOR, MINOR, PATCH].join(".").freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eth
 version: !ruby/object:Gem::Version
-  version: 0.5.10
+  version: 0.5.11
 platform: ruby
 authors:
 - Steve Ellis
@@ -9,8 +9,22 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-02 00:00:00.000000000 Z
+date: 2023-08-03 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: forwardable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: keccak
   requirement: !ruby/object:Gem::Requirement
@@ -45,14 +59,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: openssl
   requirement: !ruby/object:Gem::Requirement
@@ -120,6 +134,8 @@ files:
 - eth.gemspec
 - lib/eth.rb
 - lib/eth/abi.rb
+- lib/eth/abi/decoder.rb
+- lib/eth/abi/encoder.rb
 - lib/eth/abi/event.rb
 - lib/eth/abi/type.rb
 - lib/eth/address.rb
@@ -127,7 +143,6 @@ files:
 - lib/eth/chain.rb
 - lib/eth/client.rb
 - lib/eth/client/http.rb
-- lib/eth/client/http_auth.rb
 - lib/eth/client/ipc.rb
 - lib/eth/constant.rb
 - lib/eth/contract.rb

data/lib/eth/client/http_auth.rb

@@ -1,73 +0,0 @@
-# Copyright (c) 2016-2023 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 with basic authentication.
-  class Client::HttpAuth < 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
-
-    # Attribute for user.
-    attr_reader :user
-
-    # 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"
-      @user = uri.user
-      @password = uri.password
-      @uri = URI("#{uri.scheme}://#{uri.user}:#{uri.password}@#{@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
-
-  private
-
-  # Attribute for password.
-  attr_reader :password
-end