eth 0.4.16 → 0.5.1

data/lib/eth/util.rb

@@ -0,0 +1,235 @@
+# 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 "digest/keccak"
+
+# Provides the {Eth} module.
+module Eth
+
+  # Defines handy tools for the {Eth} gem for convenience.
+  module Util
+    extend self
+
+    # Generates an Ethereum address from a given compressed or
+    # uncompressed binary or hexadecimal public key string.
+    #
+    # @param str [String] the public key to be converted.
+    # @return [Eth::Address] an Ethereum address.
+    def public_key_to_address(str)
+      str = hex_to_bin str if is_hex? str
+      bytes = keccak256(str[1..-1])[-20..-1]
+      Address.new bin_to_prefixed_hex bytes
+    end
+
+    # Hashes a string with the Keccak-256 algorithm.
+    #
+    # @param str [String] a string to be hashed.
+    # @return [String] a Keccak-256 hash of the given string.
+    def keccak256(str)
+      Digest::Keccak.new(256).digest str
+    end
+
+    # Unpacks a binary string to a hexa-decimal string.
+    #
+    # @param bin [String] a binary string to be unpacked.
+    # @return [String] a hexa-decimal string.
+    # @raise [TypeError] if value is not a string.
+    def bin_to_hex(bin)
+      raise TypeError, "Value must be an instance of String" unless bin.instance_of? String
+      bin.unpack("H*").first
+    end
+
+    # Packs a hexa-decimal string into a binary string. Also works with
+    # `0x`-prefixed strings.
+    #
+    # @param hex [String] a hexa-decimal string to be packed.
+    # @return [String] a packed binary string.
+    # @raise [TypeError] if value is not a string or string is not hex.
+    def hex_to_bin(hex)
+      raise TypeError, "Value must be an instance of String" unless hex.instance_of? String
+      hex = remove_hex_prefix hex
+      raise TypeError, "Non-hexadecimal digit found" unless is_hex? hex
+      [hex].pack("H*")
+    end
+
+    # Prefixes a hexa-decimal string with `0x`.
+    #
+    # @param hex [String] a hex-string to be prefixed.
+    # @return [String] a prefixed hex-string.
+    def prefix_hex(hex)
+      return hex if is_prefixed? hex
+      return "0x#{hex}"
+    end
+
+    # Removes the `0x` prefix of a hexa-decimal string.
+    #
+    # @param hex [String] a prefixed hex-string.
+    # @return [String] an unprefixed hex-string.
+    def remove_hex_prefix(hex)
+      return hex[2..-1] if is_prefixed? hex
+      return hex
+    end
+
+    # Unpacks a binary string to a prefixed hexa-decimal string.
+    #
+    # @param bin [String] a binary string to be unpacked.
+    # @return [String] a prefixed hexa-decimal string.
+    def bin_to_prefixed_hex(bin)
+      prefix_hex bin_to_hex bin
+    end
+
+    # Checks if a string is hex-adecimal.
+    #
+    # @param str [String] a string to be checked.
+    # @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
+      str.match /\A[0-9a-fA-F]*\z/
+    end
+
+    # 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.
+    def is_prefixed?(hex)
+      hex.match /\A0x/
+    end
+
+    # Serializes an unsigned integer to big endian.
+    #
+    # @param num [Integer] unsigned integer to be serialized.
+    # @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 <= Constant::UINT_MAX
+        raise ArgumentError, "Integer invalid or out of range: #{num}"
+      end
+      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.
+    #
+    # @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)+/, "")
+    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.
+    #
+    # @param num [Integer] the number to ciel up.
+    # @return [Integer] the ceiled to 32 integer.
+    def ceil32(num)
+      num % 32 == 0 ? num : (num + 32 - num % 32)
+    end
+
+    # Left-pad a number with a symbol.
+    #
+    # @param str [String] a serialized string to be padded.
+    # @param sym [String] a symbol used for left-padding.
+    # @param len [Integer] number of symbols for the final string.
+    # @return [String] a left-padded serialized string of wanted size.
+    def lpad(str, sym, len)
+      return str if str.size >= len
+      sym * (len - str.size) + str
+    end
+
+    # Left-pad a serialized string with zeros.
+    #
+    # @param str [String] a serialized string to be padded.
+    # @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, Constant::BYTE_ZERO, len
+    end
+
+    # Left-pad a hex number with zeros.
+    #
+    # @param hex [String] a hex-string to be padded.
+    # @param len [Integer] number of symbols for the final string.
+    # @return [String] a zero-padded serialized string of wanted size.
+    def zpad_hex(hex, len = 32)
+      zpad hex_to_bin(hex), len
+    end
+
+    # Left-pad an unsigned integer with zeros.
+    #
+    # @param num [Integer] an unsigned integer to be padded.
+    # @param len [Integer] number of symbols for the final string.
+    # @return [String] a zero-padded serialized string of wanted size.
+    def zpad_int(num, len = 32)
+      zpad serialize_int_to_big_endian(num), len
+    end
+  end
+end

data/lib/eth/version.rb

@@ -1,3 +1,20 @@
+# 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.
+
+# Provides the {Eth} module.
 module Eth
-  VERSION = "0.4.16"
+
+  # Defines the version of the {Eth} module.
+  VERSION = "0.5.1".freeze
 end

data/lib/eth.rb

@@ -1,69 +1,35 @@
-require 'digest/sha3'
-require 'ffi'
-require 'money-tree'
-require 'rlp'
-
+# 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.
+
+# Provides the {Eth} module.
 module Eth
-  BYTE_ZERO = "\x00".freeze
-  UINT_MAX = 2**256 - 1
-
-  autoload :Address, 'eth/address'
-  autoload :Gas, 'eth/gas'
-  autoload :Key, 'eth/key'
-  autoload :OpenSsl, 'eth/open_ssl'
-  autoload :Secp256k1, 'eth/secp256k1'
-  autoload :Sedes, 'eth/sedes'
-  autoload :Tx, 'eth/tx'
-  autoload :Utils, 'eth/utils'
-
-  class << self
-    def configure
-      yield(configuration)
-    end
-
-    def replayable_chain_id
-      27
-    end
-
-    def chain_id
-      configuration.chain_id
-    end
-
-    def v_base
-      replayable_chain_id
-    end
-
-    def replayable_v?(v)
-      [replayable_chain_id, replayable_chain_id + 1].include? v
-    end
-
-    def tx_data_hex?
-      !!configuration.tx_data_hex
-    end
-
-    def chain_id_from_signature(signature)
-      return nil if Eth.replayable_v?(signature[:v])
-
-      cid = (signature[:v] - 35) / 2
-      (cid < 1) ? nil : cid
-    end
-
-    private
-
-    def configuration
-      @configuration ||= Configuration.new
-    end
-  end
-
-  class Configuration
-    attr_accessor :chain_id, :tx_data_hex
-
-    def initialize
-      self.chain_id = nil
-      self.tx_data_hex = true
-    end
-  end
-
-  class ValidationError < StandardError; end
-  class InvalidTransaction < ValidationError; end
 end
+
+# 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"
+require "eth/util"
+require "eth/version"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eth
 version: !ruby/object:Gem::Version
-  version: 0.4.16
+  version: 0.5.1
 platform: ruby
 authors:
 - Steve Ellis
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-30 00:00:00.000000000 Z
+date: 2022-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: keccak
@@ -17,56 +17,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: ffi
+  name: konstructor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: money-tree
+  name: rbsecp256k1
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '5.1'
 - !ruby/object:Gem::Dependency
-  name: rlp
+  name: openssl
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: scrypt
   requirement: !ruby/object:Gem::Requirement
@@ -81,63 +81,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.2'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.14'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.14'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.10'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.10'
-description: Library to build, parse, and sign Ethereum transactions.
+description: Library to handle Ethereum accounts, messages, and transactions.
 email:
 - email@steveell.is
 - ruby@q9f.cc
@@ -145,11 +89,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/build.yml"
 - ".github/workflows/codeql.yml"
+- ".github/workflows/docs.yml"
+- ".github/workflows/spec.yml"
 - ".gitignore"
 - ".gitmodules"
 - ".rspec"
+- ".yardopts"
+- AUTHORS.txt
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -159,25 +106,43 @@ files:
 - bin/setup
 - eth.gemspec
 - lib/eth.rb
+- lib/eth/abi.rb
+- lib/eth/abi/type.rb
 - lib/eth/address.rb
-- lib/eth/gas.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/open_ssl.rb
-- lib/eth/secp256k1.rb
-- lib/eth/sedes.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/utils.rb
+- lib/eth/tx/eip1559.rb
+- lib/eth/tx/eip2930.rb
+- lib/eth/tx/legacy.rb
+- lib/eth/unit.rb
+- lib/eth/util.rb
 - lib/eth/version.rb
-homepage: https://github.com/se3000/ruby-eth
+homepage: https://github.com/q9f/eth.rb
 licenses:
-- MIT
+- Apache-2.0
 metadata:
-  homepage_uri: https://github.com/se3000/ruby-eth
-  source_code_uri: https://github.com/se3000/ruby-eth
-  github_repo: https://github.com/se3000/ruby-eth
-  bug_tracker_uri: https://github.com/se3000/ruby-eth/issues
+  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:
@@ -186,7 +151,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.2'
+      version: '2.6'
   - - "<"
     - !ruby/object:Gem::Version
       version: '4.0'
@@ -196,8 +161,8 @@ 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: Simple API to sign Ethereum transactions.
+summary: Ruby Ethereum library.
 test_files: []

data/.github/workflows/build.yml

@@ -1,26 +0,0 @@
----
-name: Build
-
-on:
-  pull_request:
-    branches:
-      - develop
-  push:
-    branches:
-      - develop
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v2
-    - uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: 3.0
-    - name: Install Dependencies
-      run: |
-        git submodule update --init
-        bundle install
-    - name: Run Tests
-      run: |
-        rspec

data/lib/eth/gas.rb

@@ -1,9 +0,0 @@
-module Eth
-  class Gas
-
-    GTXCOST = 21000       # TX BASE GAS COST
-    GTXDATANONZERO = 68   # TX DATA NON ZERO BYTE GAS COST
-    GTXDATAZERO = 4       # TX DATA ZERO BYTE GAS COST
-
-  end
-end