eth 0.5.9 → 0.5.10

data/lib/eth/client.rb

@@ -76,6 +76,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?
       @default_account ||= Address.new eth_coinbase["result"]
     end
 
@@ -102,6 +103,17 @@ module Eth
       eth_get_transaction_count(address, "pending")["result"].to_i 16
     end
 
+    # Resolves an ENS name to an Ethereum address on the connected chain.
+    #
+    # @param ens_name [String] The ENS name, e.g., `fancy.eth`.
+    # @param registry [String] the address for the ENS registry.
+    # @param coin_type [Integer] the coin type as per EIP-2304.
+    # @return [Eth::Address] the Ethereum address resolved from the ENS record.
+    def resolve_ens(ens_name, registry = Ens::DEFAULT_ADDRESS, coin_type = Ens::CoinType::ETHEREUM)
+      ens = Ens::Resolver.new(self, registry)
+      ens.resolve(ens_name, coin_type)
+    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.
@@ -118,7 +130,7 @@ module Eth
     # if no sender key is provided.
     #
     # **Note**, that many remote providers (e.g., Infura) do not provide
-    # any accounts. Provide a `sender_key` if you experience issues.
+    # any accounts. Provide a `sender_key:` if you experience issues.
     #
     # @overload transfer(destination, amount)
     #   @param destination [Eth::Address] the destination address.
@@ -159,6 +171,9 @@ module Eth
         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,
@@ -168,6 +183,39 @@ module Eth
       end
     end
 
+    # Transfers a token that implements the ERC20 `transfer()` interface.
+    #
+    # See {#transfer_erc20} for params and overloads.
+    #
+    # @return [Object] returns the result of the transaction.
+    def transfer_erc20_and_wait(erc20_contract, destination, amount, **kwargs)
+      transact_and_wait(erc20_contract, "transfer", destination, amount, **kwargs)
+    end
+
+    # Transfers a token that implements the ERC20 `transfer()` interface.
+    #
+    # **Note**, that many remote providers (e.g., Infura) do not provide
+    # any accounts. Provide a `sender_key:` if you experience issues.
+    #
+    # @overload transfer_erc20(erc20_contract, destination, amount)
+    #   @param erc20_contract [Eth::Contract] the ERC20 contract to write to.
+    #   @param destination [Eth::Address] the destination address.
+    #   @param amount [Integer] the transfer amount (mind the `decimals()`).
+    # @overload transfer_erc20(erc20_contract, destination, amount, **kwargs)
+    #   @param erc20_contract [Eth::Contract] the ERC20 contract to write to.
+    #   @param destination [Eth::Address] the destination address.
+    #   @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 **nonce [Integer] optional specific nonce for transaction.
+    #   @param **tx_value [Integer] optional transaction value field filling.
+    # @return [Object] returns the result of the transaction.
+    def transfer_erc20(erc20_contract, destination, amount, **kwargs)
+      destination = destination.to_s if destination.instance_of? Eth::Address
+      transact(erc20_contract, "transfer", destination, amount, **kwargs)
+    end
+
     # Deploys a contract and waits for it to be mined. Uses
     # `eth_coinbase` or external signer if no sender key is provided.
     #
@@ -184,7 +232,7 @@ module Eth
     # if no sender key is provided.
     #
     # **Note**, that many remote providers (e.g., Infura) do not provide
-    # any accounts. Provide a `sender_key` if you experience issues.
+    # any accounts. Provide a `sender_key:` if you experience issues.
     #
     # @overload deploy(contract)
     #   @param contract [Eth::Contract] contracts to deploy.
@@ -238,6 +286,10 @@ module Eth
         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,
@@ -266,9 +318,15 @@ module Eth
     #   @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 }[0]
-      raise ArgumentError, "this function does not exist!" if func.nil?
-      output = call_raw(contract, func, *args, **kwargs)
+      func = contract.functions.select { |func| func.name == function }
+      raise ArgumentError, "this function does not exist!" if func.nil? || func.size === 0
+      selected_func = func.first
+      func.each do |f|
+        if f.inputs.size === args.size
+          selected_func = f
+        end
+      end
+      output = call_raw(contract, selected_func, *args, **kwargs)
       if output&.length == 1
         return output[0]
       else
@@ -280,7 +338,7 @@ module Eth
     # contract read/write).
     #
     # **Note**, that many remote providers (e.g., Infura) do not provide
-    # any accounts. Provide a `sender_key` if you experience issues.
+    # any accounts. Provide a `sender_key:` if you experience issues.
     #
     # @overload transact(contract, function)
     #   @param contract [Eth::Contract] the subject contract to write to.
@@ -334,6 +392,10 @@ module Eth
         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,
@@ -431,6 +493,17 @@ module Eth
 
     private
 
+    # Allows to determine if we work with a local connectoin
+    def local?
+      if self.instance_of? Eth::Client::Ipc
+        return true
+      elsif self.host === "127.0.0.1" || self.host === "localhost"
+        return true
+      else
+        return false
+      end
+    end
+
     # Non-transactional function call called from call().
     # @see https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_call
     def call_raw(contract, func, *args, **kwargs)

data/lib/eth/ens/coin_type.rb

@@ -0,0 +1,50 @@
+# 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.
+
+# Provides the {Eth} module.
+module Eth
+  # Provides ENS specific functionality
+  # ref: https://ens.domains
+  module Ens
+    # Provides EIP-2304 / SLIP-44 cointypes to resolve ENS addresses.
+    # ref: https://eips.ethereum.org/EIPS/eip-2304
+    module CoinType
+      extend self
+
+      # ENS coin type for Bitcoin.
+      BITCOIN = 0.freeze
+
+      # ENS coin type for Litecoin.
+      LITECOIN = 2.freeze
+
+      # ENS coin type for Dogecoin.
+      DOGECOIN = 3.freeze
+
+      # ENS coin type for Ethereum.
+      ETHEREUM = 60.freeze
+
+      # ENS coin type for Ethereum Classic.
+      ETHEREUM_CLASSIC = 61.freeze
+
+      # ENS coin type for Rootstock.
+      ROOTSTOCK = 137.freeze
+
+      # ENS coin type for Bitcoin Cash.
+      BITCOIN_CASH = 145.freeze
+
+      # ENS coin type for Binance.
+      BINANCE = 714.freeze
+    end
+  end
+end

data/lib/eth/ens/resolver.rb

@@ -16,6 +16,7 @@
 
 # Provides the {Eth} module.
 module Eth
+
   # Provides ENS specific functionality
   # ref: https://ens.domains
   module Ens
@@ -23,43 +24,84 @@ module Eth
     # Utility class for resolving ENS names to Ethereum addresses
     class Resolver
 
-      # The default address for ENS, which applies to most chains
-      DEFAULT_ADDRESS = "0x00000000000c2e074ec69a0dfb2997ba6c7d2e1e".freeze
+      # The client instance used to resolve the ENS.
+      attr_accessor :client
+
+      # The address of the ENS registry on the given chain.
+      attr_accessor :registry
 
-      # Create an instance of the ENS Resolver
+      # Create an instance of the ENS Resolver.
       #
-      # @param client [Eth::Client] The client instance
-      # @param address [String] The address of the ENS contract
+      # @param client [Eth::Client] The client instance used to resolve the ENS.
+      # @param address [String] The address of the ENS registry on the given chain.
       def initialize(client, address = DEFAULT_ADDRESS)
         @client = client
-        @contract = Eth::Contract.from_abi(
-          name: "ENS",
+        @registry = Eth::Contract.from_abi(
+          name: "ENSRegistryWithFallback",
           address: address,
-          abi: JSON.parse(File.read(File.join(File.dirname(__FILE__), "../../../abis/ens.json"))),
+          abi: JSON.parse(File.read(File.join(File.dirname(__FILE__), "../../../abi/ens_registry.json"))),
         )
       end
 
-      # Resolve an ENS name to an address
+      # Resolve an ENS name owner.
+      #
+      # @param ens_name [String] The ENS name, e.g., `fancy.eth`.
+      # @return [String] The owner address of the name as a hex string.
+      def owner(ens_name)
+        @client.call(@registry, "owner", namehash(ens_name))
+      end
+
+      # Retrieve the public resolver for the given ENS name.
       #
-      # @param ens_name [String] The ENS name, eg: fancy.eth
-      # @return [String] The owner address of the name, as a hex string
-      def resolve(ens_name)
-        @client.call(@contract, "owner", namehash(ens_name))
+      # @param ens_name [String] The ENS name, e.g., `fancy.eth`.
+      # @return [Eth::Contract] The public resolver contract that can be used
+      #   to resolve ENS names.
+      def resolver(ens_name)
+        address = @client.call(@registry, "resolver", namehash(ens_name))
+        Eth::Contract.from_abi(
+          name: "ENSPublicResolver",
+          address: address,
+          abi: JSON.parse(File.read(File.join(File.dirname(__FILE__), "../../../abi/ens_resolver.json"))),
+        )
+      end
+
+      # Resolve an ENS name to an address.
+      #
+      # @param ens_name [String] The ENS name, e.g., `fancy.eth`.
+      # @return [String] The owner address of the name as a hex string.
+      def resolve(ens_name, coin_type = Ens::CoinType::ETHEREUM)
+        if coin_type === Ens::CoinType::ETHEREUM
+          return @client.call(resolver(ens_name), "addr", namehash(ens_name))
+        elsif coin_type === Ens::CoinType::ETHEREUM_CLASSIC
+          data = @client.call(resolver(ens_name), "addr", namehash(ens_name), coin_type)
+          return Util.bin_to_prefixed_hex data
+        else
+          raise NotImplementedError, "Coin type #{coin_type} not implemented!"
+        end
+      end
+
+      # Resolve a text record for a given ENS name.
+      #
+      # @param ens_name [String] The ENS name, e.g., `fancy.eth`.
+      # @param key [String] The key for the text record, e.g., `url`.
+      # @return [String] The text record.
+      def text(ens_name, key = "description")
+        @client.call(resolver(ens_name), "text", namehash(ens_name), key)
       end
 
       # Generate node for the given domain name
       # See: https://docs.ens.domains/contract-api-reference/name-processing
       #
-      # @param ens_name [String] The ENS name, eg: fancy.eth
-      # @return [String] The node as a hex string
+      # @param ens_name [String] The ENS name, e.g., `fancy.eth`.
+      # @return [String] The node as a hex string.
       def namehash(ens_name)
-        node = ("0" * 64)
+        node = Util.hex_to_bin("0" * 64)
         name = normalize(ens_name)
         name.split(".").reverse.each do |label|
-          hash = Digest::Keccak.new(256).hexdigest(label)
-          node = Digest::Keccak.new(256).hexdigest([node + hash].pack("H*"))
+          hash = Util.keccak256(label)
+          node = Util.keccak256(node + hash)
         end
-        "0x#{node}"
+        Util.bin_to_prefixed_hex node
       end
 
       # Normalize a string as specified by http://unicode.org/reports/tr46/
@@ -67,10 +109,12 @@ module Eth
       # @param input [String] The input string
       # @return [String] The normalized output string
       def normalize(input)
-        # TODO: This is fairly complicated, and there doesn't seem to be a ruby
-        # library which can handle it perfectly.
-        # https://www.unicode.org/reports/tr46/tr46-27.html
-        input.downcase
+        name = input.dup
+        if name.gsub!(/[`~!@#$%^&*()_=+\[\]{}<>,;:'"\/\\|?]/, "").nil?
+          return input.downcase
+        else
+          raise ArgumentError, "Provided ENS name contains illegal characters: #{input}"
+        end
       end
     end
   end

data/lib/eth/ens.rb

@@ -0,0 +1,28 @@
+# 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 "eth/ens/coin_type"
+require "eth/ens/resolver"
+
+# Provides the {Eth} module.
+module Eth
+  # Provides ENS specific functionality
+  # ref: https://ens.domains
+  module Ens
+    extend self
+
+    # The default address for ENS, which applies to most chains
+    DEFAULT_ADDRESS = Address.new("0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e").freeze
+  end
+end

data/lib/eth/version.rb

@@ -16,5 +16,5 @@
 module Eth
 
   # Defines the version of the {Eth} module.
-  VERSION = "0.5.9".freeze
+  VERSION = "0.5.10".freeze
 end

data/lib/eth.rb

@@ -32,5 +32,5 @@ require "eth/solidity"
 require "eth/tx"
 require "eth/unit"
 require "eth/util"
-require "eth/ens/resolver"
+require "eth/ens"
 require "eth/version"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eth
 version: !ruby/object:Gem::Version
-  version: 0.5.9
+  version: 0.5.10
 platform: ruby
 authors:
 - Steve Ellis
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-21 00:00:00.000000000 Z
+date: 2023-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: keccak
@@ -105,11 +105,15 @@ files:
 - ".yardopts"
 - AUTHORS.txt
 - CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- abis/ens.json
+- SECURITY.md
+- abi/ens_registry.json
+- abi/ens_resolver.json
 - bin/console
 - bin/setup
 - codecov.yml
@@ -133,6 +137,8 @@ files:
 - lib/eth/contract/function_output.rb
 - lib/eth/contract/initializer.rb
 - lib/eth/eip712.rb
+- lib/eth/ens.rb
+- lib/eth/ens/coin_type.rb
 - lib/eth/ens/resolver.rb
 - lib/eth/key.rb
 - lib/eth/key/decrypter.rb
@@ -181,7 +187,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.3.25
 signing_key:
 specification_version: 4
 summary: Ruby Ethereum library.