eth 0.5.4 → 0.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af4a4068c445fcbb0ec94375ffdf650894464bf62d69dd7a14af232452c3af3c
-  data.tar.gz: a962fe008b6ecb75bdc5a70c9363aa31f95d84f82359da53e7195544bbcb9db2
+  metadata.gz: 62da01e731dd3a73a356760ac971250f193142090876e62567d73cbb5664213d
+  data.tar.gz: 8a951b1b585acd7b58dc327f122dbdd4787145fefbe09d71f1aa4d127787e99e
 SHA512:
-  metadata.gz: d909d4249f0f7a72cae28c0f4208e1aa8c8ba69779149a20ececf4a53cd6186b43062d7a9aa5921e3c3fee9f3e014df8e6dd01586c0651f714d9bca47a4953da
-  data.tar.gz: ad74d13143142ab3cf71cadfa79cbd1a7a9cf2628c0b5b6e279edd4385b20764b837e14b0f8f7f24d55884893a7b79b4c1323f89aca66adfa40eb6af8bd4db41
+  metadata.gz: fd1ca2d9f89a545f20cf23a9cff62a83bfe20514b69cb14aac88f08cd101a8bb9e26ba700539259c16d64ee2a3cbae46adf7bedd18b66835785ad701fd515681
+  data.tar.gz: a1f51f0dac47d8ce7a4ccd3df0d3decfdb0847df36a4b16587b5dd9ae217aee7375e952207d00611bcb487647ff152d958d4709ebf8b429ec0235220f45d35bd

data/.github/dependabot.yml

@@ -0,0 +1,18 @@
+---
+updates:
+  -
+    directory: /
+    labels:
+      - dependencies
+    package-ecosystem: bundler
+    schedule:
+      interval: weekly
+    versioning-strategy: increase
+  -
+    directory: /
+    labels:
+      - operations
+    package-ecosystem: github-actions
+    schedule:
+      interval: monthly
+version: 2

data/.github/workflows/codeql.yml

@@ -24,15 +24,15 @@ jobs:
           - ruby
     steps:
       - name: "Checkout repository"
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       - name: "Initialize CodeQL"
-        uses: github/codeql-action/init@v1
+        uses: github/codeql-action/init@v2
         with:
           languages: "${{ matrix.language }}"
       - name: Autobuild
-        uses: github/codeql-action/autobuild@v1
+        uses: github/codeql-action/autobuild@v2
       - name: "Perform CodeQL Analysis"
-        uses: github/codeql-action/analyze@v1
+        uses: github/codeql-action/analyze@v2
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: '2.7'

data/.github/workflows/docs.yml

@@ -10,7 +10,7 @@ jobs:
   docs:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - uses: ruby/setup-ruby@v1
       with:
         ruby-version: '2.7'
@@ -20,7 +20,7 @@ jobs:
         gem install yard
         yard doc
     - name: Deploy GH Pages
-      uses: JamesIves/github-pages-deploy-action@4.1.7
+      uses: JamesIves/github-pages-deploy-action@v4.3.3
       with:
           branch: gh-pages
           folder: doc/

data/.github/workflows/spec.yml

@@ -21,7 +21,7 @@ jobs:
         os: [ubuntu-latest, macos-latest]
         ruby: ['2.7', '3.1']
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby }}

data/CHANGELOG.md

@@ -1,6 +1,19 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [0.5.4]
+### Added
+- Eth/client: method for eip-1271 ([#80](https://github.com/q9f/eth.rb/pull/80))
+
+### Changed
+- Docs: update changelog ([#77](https://github.com/q9f/eth.rb/pull/77))
+- Gem: bump version to 0.5.4 ([#78](https://github.com/q9f/eth.rb/pull/78))
+- Ci: bump ruby version to 3.1 on ci ([#79](https://github.com/q9f/eth.rb/pull/79))
+- Fix typos ([#81](https://github.com/q9f/eth.rb/pull/81))
+- Eth/contract: allow creating from file, abi, bin ([#83](https://github.com/q9f/eth.rb/pull/83))
+- Eth/client: fix account requirement for client.call() ([#85](https://github.com/q9f/eth.rb/pull/85))
+- Add dependency support for openssl 2.2 and greater, including 3.x ([#88](https://github.com/q9f/eth.rb/pull/88))
+
 ## [0.5.3]
 ### Added
 - Smart contract support ([#68](https://github.com/q9f/eth.rb/pull/68))

data/lib/eth/abi.rb

@@ -346,6 +346,8 @@ module Eth
     # Properly encodes byte-strings.
     def encode_bytes(arg, type)
       raise EncodingError, "Expecting String: #{arg}" unless arg.instance_of? String
+      arg = handle_hex_string arg, type
+
       if type.sub_type.empty?
         size = Util.zpad_int arg.size
         padding = Constant::BYTE_ZERO * (Util.ceil32(arg.size) - arg.size)
@@ -404,5 +406,23 @@ module Eth
         raise EncodingError, "Could not parse address: #{arg}"
       end
     end
+
+    # The ABI encoder needs to be able to determine between a hex `"123"`
+    # and a binary `"123"` string.
+    def handle_hex_string(arg, type)
+      if Util.is_prefixed? arg or
+         (arg.size === type.sub_type.to_i * 2 and Util.is_hex? arg)
+
+        # There is no way telling whether a string is hex or binary with certainty
+        # in Ruby. Therefore, we assume a `0x` prefix to indicate a hex string.
+        # Additionally, if the string size is exactly the double of the expected
+        # binary size, we can assume a hex value.
+        return Util.hex_to_bin arg
+      else
+
+        # Everything else will be assumed binary or raw string.
+        return arg.b
+      end
+    end
   end
 end

data/lib/eth/chain.rb

@@ -41,6 +41,9 @@ module Eth
     # Chain ID for Gnosis mainnet.
     XDAI = 100.freeze
 
+    # Chain ID for the Polygon Matic mainnet.
+    MATIC = 137.freeze
+
     # Chain ID for Arbitrum mainnet.
     ARBITRUM = 42161.freeze
 
@@ -77,6 +80,9 @@ module Eth
     # Chain ID for Optimistic Goerli testnet.
     GOERLI_OPTIMISM = 420.freeze
 
+    # Chain ID for the Polygon Mumbai testnet.
+    MUMBAI = 80001.freeze
+
     # Chain ID for Arbitrum Rinkeby testnet.
     RINKEBY_ARBITRUM = 421611.freeze
 

data/lib/eth/client.rb

@@ -154,16 +154,14 @@ module Eth
     #
     # @overload deploy(contract)
     #   @param contract [Eth::Contract] contracts to deploy.
-    # @overload deploy(contract, sender_key)
+    # @overload deploy(contract, *args, **kwargs)
     #   @param contract [Eth::Contract] contracts to deploy.
-    #   @param sender_key [Eth::Key] the sender private key.
-    # @overload deploy(contract, sender_key, legacy)
-    #   @param contract [Eth::Contract] contracts to deploy.
-    #   @param sender_key [Eth::Key] the sender private key.
-    #   @param legacy [Boolean] enables legacy transactions (pre-EIP-1559).
+    #   *args Optional variable constructor parameter list
+    #   **sender_key [Eth::Key] the sender private key.
+    #   **legacy [Boolean] enables legacy transactions (pre-EIP-1559).
     # @return [String] the contract address.
-    def deploy_and_wait(contract, sender_key: nil, legacy: false)
-      hash = wait_for_tx(deploy(contract, sender_key: sender_key, legacy: legacy))
+    def deploy_and_wait(contract, *args, **kwargs)
+      hash = wait_for_tx(deploy(contract, *args, **kwargs))
       addr = eth_get_transaction_receipt(hash)["result"]["contractAddress"]
       contract.address = Address.new(addr).to_s
     end
@@ -173,25 +171,28 @@ module Eth
     #
     # @overload deploy(contract)
     #   @param contract [Eth::Contract] contracts to deploy.
-    # @overload deploy(contract, sender_key)
+    # @overload deploy(contract, *args, **kwargs)
     #   @param contract [Eth::Contract] contracts to deploy.
-    #   @param sender_key [Eth::Key] the sender private key.
-    # @overload deploy(contract, sender_key, legacy)
-    #   @param contract [Eth::Contract] contracts to deploy.
-    #   @param sender_key [Eth::Key] the sender private key.
-    #   @param legacy [Boolean] enables legacy transactions (pre-EIP-1559).
+    #   *args Optional variable constructor parameter list
+    #   **sender_key [Eth::Key] the sender private key.
+    #   **legacy [Boolean] enables legacy transactions (pre-EIP-1559).
     # @return [String] the transaction hash.
     # @raise [ArgumentError] in case the contract does not have any source.
-    def deploy(contract, sender_key: nil, legacy: false)
+    def deploy(contract, *args, **kwargs)
       raise ArgumentError, "Cannot deploy contract without source or binary!" if contract.bin.nil?
+      raise ArgumentError, "Missing contract constructor params!" if contract.constructor_inputs.length != args.length
       gas_limit = Tx.estimate_intrinsic_gas(contract.bin) + Tx::CREATE_GAS
+      data = contract.bin
+      unless args.empty?
+        data += encode_constructor_params(contract, args)
+      end
       params = {
         value: 0,
         gas_limit: gas_limit,
         chain_id: chain_id,
-        data: contract.bin,
+        data: data,
       }
-      if legacy
+      if kwargs[:legacy]
         params.merge!({
           gas_price: max_fee_per_gas,
         })
@@ -201,17 +202,17 @@ module Eth
           max_gas_fee: max_fee_per_gas,
         })
       end
-      unless sender_key.nil?
-        # use the provided key as sender and signer
+      unless kwargs[:sender_key].nil?
+        # Uses the provided key as sender and signer
         params.merge!({
-          from: sender_key.address,
-          nonce: get_nonce(sender_key.address),
+          from: kwargs[:sender_key].address,
+          nonce: get_nonce(kwargs[:sender_key].address),
         })
         tx = Eth::Tx.new(params)
-        tx.sign sender_key
+        tx.sign kwargs[:sender_key]
         return eth_send_raw_transaction(tx.hex)["result"]
       else
-        # use the default account as sender and external signer
+        # Uses the default account as sender and external signer
         params.merge!({
           from: default_account,
           nonce: get_nonce(default_account),
@@ -241,7 +242,7 @@ module Eth
       func = contract.functions.select { |func| func.name == function_name }[0]
       raise ArgumentError, "function_name does not exist!" if func.nil?
       output = call_raw(contract, func, *args, **kwargs)
-      if output.length == 1
+      if output&.length == 1
         return output[0]
       else
         return output
@@ -412,7 +413,7 @@ module Eth
         })
       end
       unless kwargs[:sender_key].nil?
-        # use the provided key as sender and signer
+        # Uses the provided key as sender and signer
         params.merge!({
           from: kwargs[:sender_key].address,
           nonce: get_nonce(kwargs[:sender_key].address),
@@ -422,6 +423,7 @@ module Eth
       end
       raw_result = eth_call(params)["result"]
       types = func.outputs.map { |i| i.type }
+      return nil if raw_result == "0x"
       Eth::Abi.decode(types, raw_result)
     end
 
@@ -432,6 +434,12 @@ module Eth
       "0x" + fun.signature + (encoded_str.empty? ? "0" * 64 : encoded_str)
     end
 
+    # Encodes constructor params
+    def encode_constructor_params(contract, args)
+      types = contract.constructor_inputs.map { |input| input.type }
+      Util.bin_to_hex(Eth::Abi.encode(types, args))
+    end
+
     # Prepares parameters and sends the command to the client.
     def send_command(command, args)
       args << "latest" if ["eth_getBalance", "eth_call"].include? command
@@ -469,3 +477,7 @@ module Eth
     end
   end
 end
+
+# Load the client/* libraries
+require "eth/client/http"
+require "eth/client/ipc"

data/lib/eth/contract/event.rb

@@ -16,6 +16,7 @@
 
 # Provides the {Eth} module.
 module Eth
+
   # Provide classes for contract event.
   class Contract::Event
     attr_accessor :name, :signature, :input_types, :inputs, :event_string, :address

data/lib/eth/contract/function.rb

@@ -16,6 +16,7 @@
 
 # Provides the {Eth} module.
 module Eth
+
   # Provides the methods for smart contract function.
   class Contract::Function
     attr_accessor :name, :inputs, :outputs, :signature, :constant, :function_string
@@ -36,7 +37,7 @@ module Eth
       @signature = self.class.encoded_function_signature(@function_string)
     end
 
-    # Create function strings.
+    # Creates function strings.
     #
     # @param name [String] function name.
     # @param inputs [Array<Eth::Contract::FunctionInput>] function input class list.
@@ -45,12 +46,12 @@ module Eth
       "#{name}(#{inputs.collect { |x| x.type }.join(",")})"
     end
 
-    # encode function signature.
+    # Encodes a function signature.
     #
     # @param signature [String] function signature.
     # @return [String] encoded function signature string.
     def self.encoded_function_signature(signature)
-      Digest::Keccak.hexdigest(signature, 256)[0..7]
+      Util.bin_to_hex Util.keccak256(signature)[0..3]
     end
   end
 end

data/lib/eth/contract/function_input.rb

@@ -16,6 +16,7 @@
 
 # Provides the {Eth} module.
 module Eth
+
   # Provide classes for contract function input.
   class Contract::FunctionInput
     attr_accessor :type, :name
@@ -28,7 +29,7 @@ module Eth
       @name = data["name"]
     end
 
-    # Returns types like uint256
+    # Returns complete types with subtypes, e.g., `uint256`.
     def type
       @type.base_type + @type.sub_type
     end

data/lib/eth/contract/function_output.rb

@@ -16,15 +16,20 @@
 
 # Provides the {Eth} module.
 module Eth
+
   # Provide classes for contract function output.
   class Contract::FunctionOutput
     attr_accessor :type, :name
 
+    # Constructor of the {Eth::Contract::FunctionOutput} class.
+    #
+    # @param data [Hash] contract abi data.
     def initialize(data)
       @type = Eth::Abi::Type.parse(data["type"])
       @name = data["name"]
     end
 
+    # Returns complete types with subtypes, e.g., `uint256`.
     def type
       @type.base_type + @type.sub_type
     end

data/lib/eth/contract/initializer.rb

@@ -16,6 +16,7 @@
 
 # Provides the {Eth} module.
 module Eth
+
   # Provide classes for contract initializer.
   class Contract::Initializer
     attr_accessor :contracts, :file
@@ -36,7 +37,7 @@ module Eth
       end
     end
 
-    # Build and return all contracts.
+    # Builds and returns all contracts.
     def build_all
       @contracts.each do |contract|
         contract.build

data/lib/eth/contract.rb

@@ -109,6 +109,7 @@ module Eth
         def_delegators :parent, :events
         def_delegators :parent, :address, :address=
         def_delegator :parent, :functions
+        def_delegator :parent, :constructor_inputs
         define_method :parent do
           parent
         end
@@ -133,3 +134,10 @@ module Eth
     end
   end
 end
+
+# Load the contract/* libraries
+require "eth/contract/event"
+require "eth/contract/function"
+require "eth/contract/function_input"
+require "eth/contract/function_output"
+require "eth/contract/initializer"

data/lib/eth/version.rb

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

data/lib/eth.rb

@@ -23,14 +23,7 @@ require "eth/address"
 require "eth/chain"
 require "eth/constant"
 require "eth/contract"
-require "eth/contract/event"
-require "eth/contract/function"
-require "eth/contract/function_input"
-require "eth/contract/function_output"
-require "eth/contract/initializer"
 require "eth/client"
-require "eth/client/http"
-require "eth/client/ipc"
 require "eth/eip712"
 require "eth/key"
 require "eth/rlp"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eth
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.5.5
 platform: ruby
 authors:
 - Steve Ellis
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-16 00:00:00.000000000 Z
+date: 2022-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: keccak
@@ -95,6 +95,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
 - ".github/workflows/codeql.yml"
 - ".github/workflows/docs.yml"
 - ".github/workflows/spec.yml"