eth 0.5.0 → 0.5.1

data/lib/eth/tx.rb

@@ -12,7 +12,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "rlp"
 require "konstructor"
 
 require "eth/chain"
@@ -21,14 +20,14 @@ require "eth/tx/eip2930"
 require "eth/tx/legacy"
 require "eth/unit"
 
-# Provides the `Eth` module.
+# Provides the {Eth} module.
 module Eth
 
   # Provides the `Tx` module supporting various transaction types.
   module Tx
     extend self
 
-    # Provides a special transactoin error if transaction type is unknown.
+    # Provides a special transaction error if transaction type is unknown.
     class TransactionTypeError < TypeError; end
 
     # Provides an decoder error if transaction cannot be decoded.
@@ -197,16 +196,16 @@ module Eth
     # @raise [ParameterError] if amount is invalid.
     # @raise [ParameterError] if access list is invalid.
     def validate_params(fields)
-      unless fields[:nonce] >= 0
+      if fields[:nonce].nil? or fields[:nonce] < 0
         raise ParameterError, "Invalid signer nonce #{fields[:nonce]}!"
       end
-      unless fields[:priority_fee] >= 0
+      if fields[:priority_fee].nil? or fields[:priority_fee] < 0
         raise ParameterError, "Invalid gas priority fee #{fields[:priority_fee]}!"
       end
-      unless fields[:max_gas_fee] >= 0
+      if fields[:max_gas_fee].nil? or fields[:max_gas_fee] < 0
         raise ParameterError, "Invalid max gas fee #{fields[:max_gas_fee]}!"
       end
-      unless fields[:gas_limit] >= DEFAULT_GAS_LIMIT and fields[:gas_limit] <= BLOCK_GAS_LIMIT
+      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
@@ -229,13 +228,13 @@ module Eth
     # @raise [ParameterError] if amount is invalid.
     # @raise [ParameterError] if access list is invalid.
     def validate_legacy_params(fields)
-      unless fields[:nonce] >= 0
+      if fields[:nonce].nil? or fields[:nonce] < 0
         raise ParameterError, "Invalid signer nonce #{fields[:nonce]}!"
       end
-      unless fields[:gas_price] >= 0
+      if fields[:gas_price].nil? or fields[:gas_price] < 0
         raise ParameterError, "Invalid gas price #{fields[:gas_price]}!"
       end
-      unless fields[:gas_limit] >= DEFAULT_GAS_LIMIT and fields[:gas_limit] <= BLOCK_GAS_LIMIT
+      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

data/lib/eth/unit.rb

@@ -14,7 +14,7 @@
 
 require "bigdecimal"
 
-# Provides the `Eth` module.
+# Provides the {Eth} module.
 module Eth
 
   # Provides constants for common Ethereum units.

data/lib/eth/util.rb

@@ -13,12 +13,11 @@
 # limitations under the License.
 
 require "digest/keccak"
-require "rlp"
 
-# Provides the `Eth` module.
+# Provides the {Eth} module.
 module Eth
 
-  # Defines handy tools for the `Eth` gem for convenience.
+  # Defines handy tools for the {Eth} gem for convenience.
   module Util
     extend self
 
@@ -93,7 +92,7 @@ module Eth
     # Checks if a string is hex-adecimal.
     #
     # @param str [String] a string to be checked.
-    # @return [String] a match if true; nil if not.
+    # @return [String] a match if true; `nil` if not.
     def is_hex?(str)
       return false unless str.is_a? String
       str = remove_hex_prefix str
@@ -103,7 +102,7 @@ module Eth
     # Checks if a string is prefixed with `0x`.
     #
     # @param hex [String] a string to be checked.
-    # @return [String] a match if true; nil if not.
+    # @return [String] a match if true; `nil` if not.
     def is_prefixed?(hex)
       hex.match /\A0x/
     end
@@ -111,14 +110,24 @@ module Eth
     # Serializes an unsigned integer to big endian.
     #
     # @param num [Integer] unsigned integer to be serialized.
-    # return [String] serialized big endian integer string.
-    # raises [ArgumentError] if unsigned integer is out of bounds.
+    # @return [String] serialized big endian integer string.
+    # @raise [ArgumentError] if unsigned integer is out of bounds.
     def serialize_int_to_big_endian(num)
       num = num.to_i(16) if is_hex? num
-      unless num.is_a? Integer and num >= 0 and num <= Abi::UINT_MAX
+      unless num.is_a? Integer and num >= 0 and num <= Constant::UINT_MAX
         raise ArgumentError, "Integer invalid or out of range: #{num}"
       end
-      RLP::Sedes.big_endian_int.serialize num
+      Rlp::Sedes.big_endian_int.serialize num
+    end
+
+    # Converts an integer to big endian.
+    #
+    # @param num [Integer] integer to be converted.
+    # @return [String] packed, big-endian integer string.
+    def int_to_big_endian(num)
+      hex = num.to_s(16) unless is_hex? num
+      hex = "0#{hex}" if hex.size.odd?
+      hex_to_bin hex
     end
 
     # Deserializes big endian data string to integer.
@@ -126,7 +135,55 @@ module Eth
     # @param str [String] serialized big endian integer string.
     # @return [Integer] an deserialized unsigned integer.
     def deserialize_big_endian_to_int(str)
-      RLP::Sedes.big_endian_int.deserialize str.sub(/\A(\x00)+/, "")
+      Rlp::Sedes.big_endian_int.deserialize str.sub(/\A(\x00)+/, "")
+    end
+
+    # Converts a big endian to an interger.
+    #
+    # @param str [String] big endian to be converted.
+    # @return [Integer] an unpacked integer number.
+    def big_endian_to_int(str)
+      str.unpack("H*").first.to_i(16)
+    end
+
+    # Converts a binary string to bytes.
+    #
+    # @param str [String] binary string to be converted.
+    # @return [Object] the string bytes.
+    def str_to_bytes(str)
+      is_bytes?(str) ? str : str.b
+    end
+
+    # Converts bytes to a binary string.
+    #
+    # @param bin [Object] bytes to be converted.
+    # @return [String] a packed binary string.
+    def bytes_to_str(bin)
+      bin.unpack("U*").pack("U*")
+    end
+
+    # Checks if a string is a byte-string.
+    #
+    # @param str [String] a string to check.
+    # @return [Boolean] true if it's an ASCII-8bit encoded byte-string.
+    def is_bytes?(str)
+      str && str.instance_of?(String) && str.encoding.name == Constant::BINARY_ENCODING
+    end
+
+    # Checks if the given item is a string primitive.
+    #
+    # @param item [Object] the item to check.
+    # @return [Boolean] true if it's a string primitive.
+    def is_primitive?(item)
+      item.instance_of?(String)
+    end
+
+    # Checks if the given item is a list.
+    #
+    # @param item [Object] the item to check.
+    # @return [Boolean] true if it's a list.
+    def is_list?(item)
+      !is_primitive?(item) && item.respond_to?(:each)
     end
 
     # Ceil and integer to the next multiple of 32 bytes.
@@ -154,7 +211,7 @@ module Eth
     # @param len [Integer] number of symbols for the final string.
     # @return [String] a zero-padded serialized string of wanted size.
     def zpad(str, len)
-      lpad str, Abi::BYTE_ZERO, len
+      lpad str, Constant::BYTE_ZERO, len
     end
 
     # Left-pad a hex number with zeros.

data/lib/eth/version.rb

@@ -12,9 +12,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# Provides the `Eth` module.
+# Provides the {Eth} module.
 module Eth
 
-  # Defines the version of the `Eth` module.
-  VERSION = "0.5.0".freeze
+  # Defines the version of the {Eth} module.
+  VERSION = "0.5.1".freeze
 end

data/lib/eth.rb

@@ -12,16 +12,22 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# Provides the `Eth` module.
+# Provides the {Eth} module.
 module Eth
 end
 
-# Loads the `Eth` module classes.
+# Loads the {Eth} module classes.
 require "eth/abi"
+require "eth/api"
 require "eth/address"
 require "eth/chain"
+require "eth/constant"
+require "eth/client"
+require "eth/client/http"
+require "eth/client/ipc"
 require "eth/eip712"
 require "eth/key"
+require "eth/rlp"
 require "eth/signature"
 require "eth/tx"
 require "eth/unit"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eth
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Steve Ellis
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-17 00:00:00.000000000 Z
+date: 2022-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: keccak
@@ -53,34 +53,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.1'
-- !ruby/object:Gem::Dependency
-  name: rlp
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.7'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: openssl
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: scrypt
   requirement: !ruby/object:Gem::Requirement
@@ -109,6 +95,7 @@ files:
 - ".gitignore"
 - ".gitmodules"
 - ".rspec"
+- ".yardopts"
 - AUTHORS.txt
 - CHANGELOG.md
 - Gemfile
@@ -120,14 +107,25 @@ files:
 - eth.gemspec
 - lib/eth.rb
 - lib/eth/abi.rb
-- lib/eth/abi/constant.rb
 - lib/eth/abi/type.rb
 - lib/eth/address.rb
+- lib/eth/api.rb
 - lib/eth/chain.rb
+- lib/eth/client.rb
+- lib/eth/client/http.rb
+- lib/eth/client/ipc.rb
+- lib/eth/constant.rb
 - lib/eth/eip712.rb
 - lib/eth/key.rb
 - lib/eth/key/decrypter.rb
 - lib/eth/key/encrypter.rb
+- lib/eth/rlp.rb
+- lib/eth/rlp/decoder.rb
+- lib/eth/rlp/encoder.rb
+- lib/eth/rlp/sedes.rb
+- lib/eth/rlp/sedes/big_endian_int.rb
+- lib/eth/rlp/sedes/binary.rb
+- lib/eth/rlp/sedes/list.rb
 - lib/eth/signature.rb
 - lib/eth/tx.rb
 - lib/eth/tx/eip1559.rb
@@ -140,10 +138,11 @@ homepage: https://github.com/q9f/eth.rb
 licenses:
 - Apache-2.0
 metadata:
-  homepage_uri: https://github.com/q9f/eth.rb
-  source_code_uri: https://github.com/q9f/eth.rb
-  github_repo: https://github.com/q9f/eth.rb
   bug_tracker_uri: https://github.com/q9f/eth.rb/issues
+  changelog_uri: https://github.com/q9f/eth.rb/blob/main/CHANGELOG.md
+  documentation_uri: https://q9f.github.io/eth.rb/
+  github_repo: https://github.com/q9f/eth.rb
+  source_code_uri: https://github.com/q9f/eth.rb
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -162,7 +161,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.29
+rubygems_version: 3.3.5
 signing_key:
 specification_version: 4
 summary: Ruby Ethereum library.

data/lib/eth/abi/constant.rb

@@ -1,63 +0,0 @@
-# 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.
-
-#  -*- encoding : ascii-8bit -*-
-
-# Provides the `Eth` module.
-module Eth
-
-  # Provides a Ruby implementation of the Ethereum Applicatoin Binary Interface (ABI).
-  module Abi
-
-    # Provides commonly used constants, such as zero bytes or zero keys.
-    module Constant
-
-      # The empty byte is defined as "".
-      BYTE_EMPTY = "".freeze
-
-      # The zero byte is 0x00.
-      BYTE_ZERO = "\x00".freeze
-
-      # The byte one is 0x01.
-      BYTE_ONE = "\x01".freeze
-
-      # The size of a 32-bit number.
-      TT32 = (2 ** 32).freeze
-
-      # The size of a 256-bit number.
-      TT256 = (2 ** 256).freeze
-
-      # The maximum possible value of an UInt256.
-      UINT_MAX = (2 ** 256 - 1).freeze
-
-      # The minimum possible value of an UInt256.
-      UINT_MIN = 0.freeze
-
-      # The maximum possible value of an Int256.
-      INT_MAX = (2 ** 255 - 1).freeze
-
-      # The minimum possible value of an Int256.
-      INT_MIN = (-2 ** 255).freeze
-
-      # A hash containing only zeros.
-      HASH_ZERO = ("\x00" * 32).freeze
-
-      # A private key containing only zeros.
-      PRIVKEY_ZERO = ("\x00" * 32).freeze
-
-      # A private key containing only zeros (hex).
-      PRIVKEY_ZERO_HEX = ("0" * 64).freeze
-    end
-  end
-end