eth 0.5.17 → 0.5.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98f8ce464d7df37a4eba624469d53362687773991ccabf623e9d91d78e450479
-  data.tar.gz: ce0601d35ca795205565e541c97115f396c5e7553a9aa6a76421167bf6bc4e69
+  metadata.gz: 760b6de4102268368fd7ef4f0f4f567192b0ddc52353f67ea6e7d5ca95fcba66
+  data.tar.gz: 614de2331a7cd3dfd45d036574a2bebef57d14c6f07070edd11ffc95be381b4d
 SHA512:
-  metadata.gz: fb9c363ec65417ce041a3a847f3d573a2128724fabb1b80483453c3097c1f726b123d78fb546b15a691ab83e64e2409ef7ef8d40461348c3948014ad52159991
-  data.tar.gz: 869b4229c3861eb7be055d0b5559e039269e267ad79203d9f4dd2923d8a08e863af9afce2cb6e973e74130db2fd6a4a04c084a0bc7460b167ab50b3813fa1592
+  metadata.gz: b21c15db4d30b89d829bd8025805171d53485d3c98fc0d72bfaf0b5d2f88b758f542658c78191e3b7f80c9c796a16cf3808dd41c6418862baa1c51694b0ee743
+  data.tar.gz: 7bedd93e3e673e8c5710ed4ede25428d30ed5c96cdee707f56a7b3462e45b1ed47fa6e06d5f07f0bcb5619e839e385dfa761d66a53975b6e19e2d1321aec67a4

data/.github/workflows/codeql.yml

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

data/.github/workflows/docs.yml

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

data/.github/workflows/spec.yml

@@ -19,9 +19,14 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, macos-latest]
-        ruby: ['3.4', '4.0']
+        ruby: [
+            { version: "3.4", bigdecimal: "~> 3.0" },
+            { version: "4.0", bigdecimal: "~> 4.0" },
+          ]
+    env:
+      BIGDECIMAL_VERSION: ${{ matrix.ruby.bigdecimal }}
     steps:
-    - uses: actions/checkout@v6
+    - uses: actions/checkout@v7
     - name: MacOs Dependencies
       if: matrix.os == 'macos-latest'
       run: |
@@ -36,7 +41,7 @@ jobs:
         sudo apt-get install -y autoconf automake libtool pkg-config geth solc
     - uses: ruby/setup-ruby@v1
       with:
-        ruby-version: ${{ matrix.ruby }}
+        ruby-version: ${{ matrix.ruby.version }}
         bundler-cache: true
     - name: Run Geth
       run: |
@@ -67,7 +72,7 @@ jobs:
           tail -n 200 /tmp/geth.log
         fi
     - name: Upload coverage to Codecov
-      uses: codecov/codecov-action@v5
+      uses: codecov/codecov-action@v7
       with:
         fail_ci_if_error: true
         token: ${{ secrets.CODECOV_TOKEN }}

data/CHANGELOG.md

@@ -1,6 +1,51 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [0.5.18]
+### Added
+* Add support for BigDecimal 4.x [#402](https://github.com/q9f/eth.rb/pull/402)
+
+### Changed
+* Docs: add SPEC, ACCEPTANCE, and per-domain spec contracts [#405](https://github.com/q9f/eth.rb/pull/405)
+* Build(deps): bump codecov/codecov-action from 6 to 7 [#404](https://github.com/q9f/eth.rb/pull/404)
+* Build(deps): bump actions/checkout from 6 to 7 [#403](https://github.com/q9f/eth.rb/pull/403)
+* Build(deps): bump codecov/codecov-action from 5 to 6 [#400](https://github.com/q9f/eth.rb/pull/400)
+* Build(deps): bump JamesIves/github-pages-deploy-action [#399](https://github.com/q9f/eth.rb/pull/399)
+* Bump version to 0.5.18
+
+## [0.5.17]
+### Added
+* Add JSONRPC error code to Client::RpcError [#392](https://github.com/q9f/eth.rb/pull/392)
+
+### Changed
+* Update workflow Ruby versions and deploy action [#397](https://github.com/q9f/eth.rb/pull/397)
+* Build(deps): bump JamesIves/github-pages-deploy-action [#395](https://github.com/q9f/eth.rb/pull/395)
+* Build(deps): bump actions/checkout from 5 to 6 [#394](https://github.com/q9f/eth.rb/pull/394)
+* Update README.md [#393](https://github.com/q9f/eth.rb/pull/393)
+* Bump version to 0.5.17 [#398](https://github.com/q9f/eth.rb/pull/398)
+
+## [0.5.16]
+### Added
+* Add WebSocket transport to client [#388](https://github.com/q9f/eth.rb/pull/388)
+* Support tuple arrays in ABI coder [#387](https://github.com/q9f/eth.rb/pull/387)
+* Add sign and public key helpers for BLS [#366](https://github.com/q9f/eth.rb/pull/366)
+* Add tuple array ABI support [#369](https://github.com/q9f/eth.rb/pull/369)
+
+### Changed
+* Build(deps): bump github/codeql-action from 3 to 4 [#390](https://github.com/q9f/eth.rb/pull/390)
+* Client/ws: fix client origin headers for ws requests [#391](https://github.com/q9f/eth.rb/pull/391)
+* Rename websocket client to Ws and expand websocket tests [#389](https://github.com/q9f/eth.rb/pull/389)
+* Format EIP-4844 transaction constant [#386](https://github.com/q9f/eth.rb/pull/386)
+* Fix ABI tuple handling for ethers test cases [#385](https://github.com/q9f/eth.rb/pull/385)
+* Increase blob throughput limits [#363](https://github.com/q9f/eth.rb/pull/363)
+* Feat: use httpx for http requests [#382](https://github.com/q9f/eth.rb/pull/382)
+* Fix: transform hash keys to strings in encoder for component type compatibility [#378](https://github.com/q9f/eth.rb/pull/378)
+* Fix: improve error handling for missing keys in component encoding [#376](https://github.com/q9f/eth.rb/pull/376)
+* Build(deps): bump actions/checkout from 4 to 5 [#379](https://github.com/q9f/eth.rb/pull/379)
+* Test: add abi decode case for prefixed hex data [#374](https://github.com/q9f/eth.rb/pull/374)
+* Add tests for decoder static arrays and encoder helpers [#373](https://github.com/q9f/eth.rb/pull/373)
+* Chore: bump version to 0.5.16 [#362](https://github.com/q9f/eth.rb/pull/362)
+
 ## [0.5.15]
 ### Added
 * Implement EIP712 array encoding [#361](https://github.com/q9f/eth.rb/pull/361)

data/Gemfile

@@ -2,6 +2,8 @@
 
 source "https://rubygems.org"
 
+gem "bigdecimal", ENV.fetch("BIGDECIMAL_VERSION", "~> 4.0")
+
 group :test, :development do
   gem "bundler", ">= 2.4"
   gem "pry", "~> 0.15"

data/eth.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
     "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",
+    "rubygems_mfa_required" => "true",
     "source_code_uri" => "https://github.com/q9f/eth.rb",
   }.freeze
 
@@ -35,7 +36,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = ">= 3.0", "< 5.0"
 
   # bigdecimal for big decimals ;)
-  spec.add_dependency "bigdecimal", "~> 3.1"
+  spec.add_dependency "bigdecimal", ">= 3.1", "< 5.0"
 
   # forwardable for contracts meta programming
   spec.add_dependency "forwardable", "~> 1.3"

data/lib/eth/client/http.rb

@@ -69,6 +69,17 @@ module Eth
       response = @client.post(@uri, body: payload)
       response.body.to_s
     end
+
+    # Closes the underlying HTTP session and releases all persistent
+    # connections held in its pool. Once closed, the client cannot be
+    # used anymore; any subsequent request raises an `IOError`. Safe to
+    # call multiple times.
+    #
+    # @return [void]
+    def close
+      @closed = true
+      @client.close
+    end
   end
 
   private

data/lib/eth/client/ipc.rb

@@ -43,8 +43,9 @@ module Eth
       until read.end_with?("\n")
         read = read << socket.recvmsg(nil)[0]
       end
-      socket.close
       return read
+    ensure
+      socket.close unless socket.nil? || socket.closed?
     end
   end
 end

data/lib/eth/client/ws.rb

@@ -76,11 +76,16 @@ module Eth
       end
     end
 
-    # Closes the underlying WebSocket connection.
+    # Closes the underlying WebSocket connection. Once closed, the
+    # client cannot be used anymore; any subsequent request raises an
+    # `IOError`. Safe to call multiple times.
     #
     # @return [void]
     def close
-      @mutex.synchronize { close_socket }
+      @mutex.synchronize do
+        @closed = true
+        close_socket
+      end
     end
 
     private

data/lib/eth/client.rb

@@ -81,6 +81,7 @@ module Eth
     # use {Client.create} intead.
     def initialize(_)
       @id = 0
+      @closed = false
       @max_priority_fee_per_gas = Tx::DEFAULT_PRIORITY_FEE
       @max_fee_per_gas = Tx::DEFAULT_GAS_PRICE
     end
@@ -378,6 +379,23 @@ module Eth
       @id = 0
     end
 
+    # Closes the client and releases any resources held by the underlying
+    # connection, such as persistent HTTP connections or an open WebSocket
+    # stream. Once closed, the client cannot be used anymore; any
+    # subsequent request raises an `IOError`. Safe to call multiple times.
+    #
+    # @return [void]
+    def close
+      @closed = true
+    end
+
+    # Checks whether the client has been closed via {#close}.
+    #
+    # @return [Boolean] true if the client is closed.
+    def closed?
+      !!@closed
+    end
+
     # Checks whether a transaction is mined or not.
     #
     # @param hash [String] the transaction hash.
@@ -476,6 +494,7 @@ module Eth
 
     # Prepares parameters and sends the command to the client.
     def send_command(command, args)
+      raise IOError, "The client is closed!" if closed?
       @block_number ||= "latest"
       args << block_number if ["eth_getBalance", "eth_call"].include? command
       payload = {

data/lib/eth/contract.rb

@@ -45,6 +45,10 @@ module Eth
       @bin = bin
       @abi = abi
       @constructor_inputs, @functions, @events, @errors = parse_abi(abi)
+      @sigs2events = {}
+      @events.each do |event|
+        @sigs2events[event.signature] = event
+      end
     end
 
     # Creates a contract wrapper from a Solidity file.
@@ -168,6 +172,7 @@ module Eth
         def_delegator :parent, :function
         def_delegator :parent, :error
         def_delegator :parent, :decode_error
+        def_delegator :parent, :decode_log
         def_delegator :parent, :constructor_inputs
         define_method :parent do
           parent
@@ -178,6 +183,21 @@ module Eth
       @class_object = class_methods
     end
 
+    # Decodes an event log by looking up the event signature in the
+    # contract ABI.
+    #
+    # @param topics [Array<String>] the list of log topics, including the
+    #   event selector.
+    # @param data [String] the log data containing non-indexed parameters.
+    # @return [Hash] a hash of decoded event parameters.
+    # @raise [ArgumentError] if the event is not part of the contract ABI.
+    def decode_log(topics, data)
+      sig = Eth::Util.remove_hex_prefix(topics[0])
+      event = @sigs2events[sig]
+      raise ArgumentError, "this event does not exist!" if event.nil?
+      event.decode_params(topics, data)
+    end
+
     private
 
     def parse_abi(abi)

data/lib/eth/tx/eip7702.rb

@@ -27,14 +27,21 @@ module Eth
       # code which the signer desires to execute in the context of their EOA.
       class Authorization
 
+        # The EIP-7702 magic byte, prefixed to the RLP-encoded authorization
+        # tuple before hashing so that authorization signatures cannot be
+        # replayed as transaction signatures.
+        # Ref: https://eips.ethereum.org/EIPS/eip-7702
+        MAGIC = 0x05.freeze
+
         # The EIP-155 Chain ID.
         # Ref: https://eips.ethereum.org/EIPS/eip-155
         attr_reader :chain_id
 
-        # The authority addess.
+        # The delegation target: the address whose code the authority's
+        # account runs. The authority itself is the signer.
         attr_reader :address
 
-        # The transaction nonce.
+        # The authority's account nonce this authorization is valid for.
         attr_reader :nonce
 
         # The signature's y-parity byte (not v).
@@ -52,8 +59,8 @@ module Eth
         #
         # @param fields [Hash] all necessary transaction fields.
         # @option fields [Integer] :chain_id the chain ID.
-        # @option fields [Eth::Address] :address the authority address.
-        # @option fields [Integer] :nonce the transaction nonce.
+        # @option fields [Eth::Address] :address the delegation target address.
+        # @option fields [Integer] :nonce the authority's account nonce.
         def initialize(fields)
           @chain_id = fields[:chain_id].to_i
           @address = fields[:address].to_s
@@ -63,46 +70,63 @@ module Eth
           @signature_s = fields[:s]
         end
 
-        # Sign the authorization with a given key.
+        # Sign the authorization with a given key. The key's account becomes
+        # the authority, delegating to the code at {#address}; any key may
+        # sign for any delegation target.
+        #
+        # The signed authorization is valid on chain {#chain_id}, or on any
+        # chain if that is 0. Anyone holding it can submit it while the
+        # account's nonce equals {#nonce}; on each chain where it is included,
+        # the code at {#address} then acts as the account until the account
+        # delegates elsewhere. Sign only for code you trust.
         #
         # @param key [Eth::Key] the key-pair to use for signing.
-        # @return [String] a transaction hash.
+        # @return [String] the hex-encoded hash that was signed, {#unsigned_hash}.
         # @raise [Signature::SignatureError] if authorization is already signed.
-        # @raise [Signature::SignatureError] if sender address does not match signing key.
+        # @raise [Address::CheckSumError] if {#address} is not a valid address.
         def sign(key)
           if Tx.signed? self
             raise Signature::SignatureError, "Authorization is already signed!"
           end
 
-          # ensure the sender address matches the given key
-          unless @address.nil? or @address.empty?
-            signer_address = Tx.sanitize_address key.address.to_s
-            from_address = Tx.sanitize_address @address
-            raise Signature::SignatureError, "Signer does not match sender" unless signer_address == from_address
-          end
+          # reject a delegation target that is not a valid address: malformed
+          # input yields a tuple clients reject, and an EIP-55 checksum
+          # mismatch most likely means a typo in the target
+          Address.new @address
 
-          # sign a keccak hash of the unsigned, encoded transaction
-          signature = key.sign(unsigned_hash, @chain_id)
+          # sign a keccak hash of the magic-prefixed, encoded authorization;
+          # the chain ID is part of that payload, so the signature carries no
+          # EIP-155 v and the y-parity is the raw recovery id
+          sign_hash = unsigned_hash
+          signature = key.sign(sign_hash)
           r, s, v = Signature.dissect signature
-          recovery_id = Chain.to_recovery_id v.to_i(16), @chain_id
+          recovery_id = Chain.to_recovery_id v.to_i(16)
           @signature_y_parity = recovery_id
           @signature_r = r
           @signature_s = s
-          return hash
+          return Util.bin_to_hex sign_hash
         end
 
-        # Encodes the unsigned authorization payload required for signing.
+        # Encodes the unsigned authorization payload required for signing:
+        # the {MAGIC} byte followed by `rlp([chain_id, address, nonce])`.
         #
-        # @return [String] an RLP-encoded, unsigned, enveloped EIP-7702 transaction.
+        # @return [String] the magic-prefixed, RLP-encoded authorization tuple.
         def unsigned_encoded
           authorization_data = []
           authorization_data.push Util.serialize_int_to_big_endian @chain_id
           authorization_data.push Util.hex_to_bin @address
           authorization_data.push Util.serialize_int_to_big_endian @nonce
-          Rlp.encode authorization_data
+          authorization_encoded = Rlp.encode authorization_data
+
+          # prefix the EIP-7702 magic byte to separate the signing domain
+          magic = Util.serialize_int_to_big_endian MAGIC
+
+          return "#{magic}#{authorization_encoded}"
         end
 
-        # Gets the sign-hash required to sign.
+        # Gets the sign-hash required to sign: the Keccak-256 hash of
+        # {#unsigned_encoded}, which an EIP-7702 client recovers the
+        # authority from.
         #
         # @return [String] a Keccak-256 hash.
         def unsigned_hash

data/lib/eth/version.rb

@@ -22,7 +22,7 @@ module Eth
   MINOR = 5.freeze
 
   # Defines the patch version of the {Eth} module.
-  PATCH = 17.freeze
+  PATCH = 18.freeze
 
   # Defines the version string of the {Eth} module.
   VERSION = [MAJOR, MINOR, PATCH].join(".").freeze

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eth
 version: !ruby/object:Gem::Version
-  version: 0.5.17
+  version: 0.5.18
 platform: ruby
 authors:
 - Steve Ellis
@@ -14,16 +14,22 @@ dependencies:
   name: bigdecimal
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: forwardable
   requirement: !ruby/object:Gem::Requirement
@@ -238,6 +244,7 @@ metadata:
   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
+  rubygems_mfa_required: 'true'
   source_code_uri: https://github.com/q9f/eth.rb
 rdoc_options: []
 require_paths: