eth 0.5.1 → 0.5.4

data/lib/eth/solidity.rb

@@ -0,0 +1,75 @@
+# 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 "open3"
+
+# Provides the {Eth} module.
+module Eth
+
+  # Class to create {Solidity} compiler bingings for Ruby.
+  class Solidity
+
+    # Provides a Compiler Error in case the contract does not compile.
+    class CompilerError < StandardError; end
+
+    # Solidity compiler binary path.
+    attr_reader :compiler
+
+    # Instantiates a Solidity `solc` system compiler binding that can be
+    # used to compile Solidity contracts.
+    def initialize
+
+      # Currently only supports `solc`.
+      solc = get_compiler_path
+      raise SystemCallError, "Unable to find the solc compiler path!" if solc.nil?
+      @compiler = solc
+    end
+
+    # Use the bound Solidity executable to compile the given contract.
+    #
+    # @param contract [String] path of the contract to compile.
+    # @return [Array] JSON containing the compiled contract and ABI for all contracts.
+    def compile(contract)
+      raise Errno::ENOENT, "Contract file not found: #{contract}" unless File.exist? contract
+      command = "#{@compiler} --optimize --combined-json bin,abi #{contract}"
+      output, error, status = Open3.capture3 command
+      raise SystemCallError, "Unable to run solc compiler!" if status.exitstatus === 127
+      raise CompilerError, error unless status.success?
+      json = JSON.parse output
+      result = {}
+      json["contracts"].each do |key, value|
+        _file, name = key.split ":"
+        result[name] = {}
+        result[name]["abi"] = value["abi"]
+        result[name]["bin"] = value["bin"]
+      end
+      return result
+    end
+
+    private
+
+    # Tries to find a system executable path for the given compiler binary name.
+    def get_compiler_path(name = "solc")
+      extensions = [""]
+      extensions = ENV["PATHEXT"].split(";") unless ENV["PATHEXT"].nil?
+      ENV["PATH"].split(File::PATH_SEPARATOR).each do |path|
+        extensions.each do |ext|
+          executable = File.join path, "#{name}#{ext}"
+          return executable if File.executable? executable and !File.directory? executable
+        end
+      end
+      return nil
+    end
+  end
+end

data/lib/eth/tx/eip1559.rb

@@ -95,6 +95,7 @@ module Eth
 
         # ensure sane values for all mandatory fields
         fields = Tx.validate_params fields
+        fields = Tx.validate_eip1559_params fields
         fields[:access_list] = Tx.sanitize_list fields[:access_list]
 
         # ensure gas limit is not too low

data/lib/eth/tx/eip2930.rb

@@ -92,6 +92,7 @@ module Eth
         fields[:data] = Tx.sanitize_data fields[:data]
 
         # ensure sane values for all mandatory fields
+        fields = Tx.validate_params fields
         fields = Tx.validate_legacy_params fields
         fields[:access_list] = Tx.sanitize_list fields[:access_list]
 

data/lib/eth/tx/legacy.rb

@@ -83,6 +83,7 @@ module Eth
         fields[:data] = Tx.sanitize_data fields[:data]
 
         # ensure sane values for all mandatory fields
+        fields = Tx.validate_params fields
         fields = Tx.validate_legacy_params fields
 
         # ensure gas limit is not too low

data/lib/eth/tx.rb

@@ -69,13 +69,16 @@ module Eth
     # The zero byte is 0x00.
     ZERO_BYTE = "\x00".freeze
 
+    # Smart contract transaction gas cost
+    CREATE_GAS = 32_000.freeze
+
     # Creates a new transaction of any type for given parameters and chain ID.
     # Required parameters are (optional in brackets):
     # - EIP-1559: chain_id, nonce, priority_fee, max_gas_fee, gas_limit(, from, to,
     #   value, data, access_list)
     # - EIP-2930: chain_id, nonce, gas_price, gas_limit, access_list(, from, to,
     #   value, data)
-    # - Legacy: nonce, gas_price, gas_lmit(, from, to, value, data)
+    # - Legacy: nonce, gas_price, gas_limit(, from, to, value, data)
     #
     # @param params [Hash] all necessary transaction fields.
     # @param chain_id [Integer] the EIP-155 Chain ID (legacy transactions only).
@@ -184,14 +187,12 @@ module Eth
       return gas
     end
 
-    # Validates the common type-2 transaction fields such as nonce, priority
-    # fee, max gas fee, gas limit, amount, and access list.
+    # Validates the common transaction fields such as nonce, gas limit,
+    # amount, and access list.
     #
     # @param fields [Hash] the transaction fields.
     # @return [Hash] the validated transaction fields.
     # @raise [ParameterError] if nonce is an invalid integer.
-    # @raise [ParameterError] if priority fee is invalid.
-    # @raise [ParameterError] if max gas fee is invalid.
     # @raise [ParameterError] if gas limit is invalid.
     # @raise [ParameterError] if amount is invalid.
     # @raise [ParameterError] if access list is invalid.
@@ -199,12 +200,6 @@ module Eth
       if fields[:nonce].nil? or fields[:nonce] < 0
         raise ParameterError, "Invalid signer nonce #{fields[:nonce]}!"
       end
-      if fields[:priority_fee].nil? or fields[:priority_fee] < 0
-        raise ParameterError, "Invalid gas priority fee #{fields[:priority_fee]}!"
-      end
-      if fields[:max_gas_fee].nil? or fields[:max_gas_fee] < 0
-        raise ParameterError, "Invalid max gas fee #{fields[:max_gas_fee]}!"
-      end
       if fields[:gas_limit].nil? or fields[:gas_limit] < DEFAULT_GAS_LIMIT or fields[:gas_limit] > BLOCK_GAS_LIMIT
         raise ParameterError, "Invalid gas limit #{fields[:gas_limit]}!"
       end
@@ -217,32 +212,32 @@ module Eth
       return fields
     end
 
-    # Validates the common legacy transaction fields such as nonce, gas
-    # price, gas limit, amount, and access list.
+    # Validates the common type-2 transaction fields such as priority
+    # fee and max gas fee.
+    #
+    # @param fields [Hash] the transaction fields.
+    # @return [Hash] the validated transaction fields.
+    # @raise [ParameterError] if priority fee is invalid.
+    # @raise [ParameterError] if max gas fee is invalid.
+    def validate_eip1559_params(fields)
+      if fields[:priority_fee].nil? or fields[:priority_fee] < 0
+        raise ParameterError, "Invalid gas priority fee #{fields[:priority_fee]}!"
+      end
+      if fields[:max_gas_fee].nil? or fields[:max_gas_fee] < 0
+        raise ParameterError, "Invalid max gas fee #{fields[:max_gas_fee]}!"
+      end
+      return fields
+    end
+
+    # Validates the common legacy transaction fields such as gas price.
     #
     # @param fields [Hash] the transaction fields.
     # @return [Hash] the validated transaction fields.
-    # @raise [ParameterError] if nonce is an invalid integer.
     # @raise [ParameterError] if gas price is invalid.
-    # @raise [ParameterError] if gas limit is invalid.
-    # @raise [ParameterError] if amount is invalid.
-    # @raise [ParameterError] if access list is invalid.
     def validate_legacy_params(fields)
-      if fields[:nonce].nil? or fields[:nonce] < 0
-        raise ParameterError, "Invalid signer nonce #{fields[:nonce]}!"
-      end
       if fields[:gas_price].nil? or fields[:gas_price] < 0
         raise ParameterError, "Invalid gas price #{fields[:gas_price]}!"
       end
-      if fields[:gas_limit].nil? or fields[:gas_limit] < DEFAULT_GAS_LIMIT or fields[:gas_limit] > BLOCK_GAS_LIMIT
-        raise ParameterError, "Invalid gas limit #{fields[:gas_limit]}!"
-      end
-      unless fields[:value] >= 0
-        raise ParameterError, "Invalid transaction value #{fields[:value]}!"
-      end
-      unless fields[:access_list].nil? or fields[:access_list].is_a? Array
-        raise ParameterError, "Invalid access list #{fields[:access_list]}!"
-      end
       return fields
     end
 

data/lib/eth/version.rb

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

data/lib/eth.rb

@@ -22,6 +22,12 @@ require "eth/api"
 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"
@@ -29,6 +35,7 @@ require "eth/eip712"
 require "eth/key"
 require "eth/rlp"
 require "eth/signature"
+require "eth/solidity"
 require "eth/tx"
 require "eth/unit"
 require "eth/util"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eth
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.4
 platform: ruby
 authors:
 - Steve Ellis
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-31 00:00:00.000000000 Z
+date: 2022-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: keccak
@@ -57,16 +57,22 @@ dependencies:
   name: openssl
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: scrypt
   requirement: !ruby/object:Gem::Requirement
@@ -104,9 +110,11 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- codecov.yml
 - eth.gemspec
 - lib/eth.rb
 - lib/eth/abi.rb
+- lib/eth/abi/event.rb
 - lib/eth/abi/type.rb
 - lib/eth/address.rb
 - lib/eth/api.rb
@@ -115,6 +123,12 @@ files:
 - lib/eth/client/http.rb
 - lib/eth/client/ipc.rb
 - lib/eth/constant.rb
+- lib/eth/contract.rb
+- lib/eth/contract/event.rb
+- lib/eth/contract/function.rb
+- lib/eth/contract/function_input.rb
+- lib/eth/contract/function_output.rb
+- lib/eth/contract/initializer.rb
 - lib/eth/eip712.rb
 - lib/eth/key.rb
 - lib/eth/key/decrypter.rb
@@ -127,6 +141,7 @@ files:
 - lib/eth/rlp/sedes/binary.rb
 - lib/eth/rlp/sedes/list.rb
 - lib/eth/signature.rb
+- lib/eth/solidity.rb
 - lib/eth/tx.rb
 - lib/eth/tx/eip1559.rb
 - lib/eth/tx/eip2930.rb
@@ -161,7 +176,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.5
+rubygems_version: 3.3.8
 signing_key:
 specification_version: 4
 summary: Ruby Ethereum library.