eth 0.5.14 → 0.5.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5f56a3acb3981d3087e8125660e5670b8ba8bf6a5255e2742e439498327cd82
-  data.tar.gz: c54057d9b851ad567e846e390949927afe1986387eaba95fc8facb0aa3fef20d
+  metadata.gz: ad70051a0aa71d2f7ed5a4acea236b677c9d1f4eb3467f8194de19a8de9f8714
+  data.tar.gz: 5558228d301116bd2be49ac184c01f3c2d1cb0e725deb9ab3f070021927b63cf
 SHA512:
-  metadata.gz: ee0dacd29dde60d8368c382a8d0fdf444895a66f2795689961112f34e752fced4a350e26b255d5bc4b1872e7c423c5780cc35487bd2b349f984ac0f75facbfd8
-  data.tar.gz: ca7fbe6c973aceb5dcc56031dbfa03903392ba9ad2ff0aa90d29c4c6311cc899961954e606c9c400df523305815eb89b26bc1fed2c0d65fcb042b59f0b63064f
+  metadata.gz: acf9b6267efa46befed740d7d00c5938ed8d384b3297c57953f71c2ae5ebac31bd279a44694dd3675f77648f66e381dccacb70f533896600b3fd1bdc15a04a3b
+  data.tar.gz: dbb137aa5449234ba86f64951740d0f985693f37d1da329a70b7efdfb44b17a8bb2511a74560ac07a8d116aba100894e584c55fc3cc367c5c91e48fed456593a

data/.github/workflows/codeql.yml

@@ -24,15 +24,15 @@ jobs:
           - ruby
     steps:
       - name: "Checkout repository"
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: "Initialize CodeQL"
-        uses: github/codeql-action/init@v3
+        uses: github/codeql-action/init@v4
         with:
           languages: "${{ matrix.language }}"
       - name: Autobuild
-        uses: github/codeql-action/autobuild@v3
+        uses: github/codeql-action/autobuild@v4
       - name: "Perform CodeQL Analysis"
-        uses: github/codeql-action/analyze@v3
+        uses: github/codeql-action/analyze@v4
       - 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@v4
+    - uses: actions/checkout@v5
     - uses: ruby/setup-ruby@v1
       with:
         ruby-version: '3.4'

data/.github/workflows/spec.yml

@@ -21,33 +21,51 @@ jobs:
         os: [ubuntu-latest, macos-latest]
         ruby: ['3.3', '3.4']
     steps:
-    - uses: actions/checkout@v4
-    - uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby }}
-        bundler-cache: false
+    - uses: actions/checkout@v5
     - name: MacOs Dependencies
+      if: matrix.os == 'macos-latest'
       run: |
+        brew update
         brew tap ethereum/ethereum
-        brew install --verbose pkg-config automake autogen geth solidity
-      if: startsWith(matrix.os, 'macOS')
+        brew install --verbose autoconf automake libtool pkg-config autogen geth solidity
     - name: Ubuntu Dependencies
+      if: matrix.os == 'ubuntu-latest'
       run: |
         sudo add-apt-repository -y ppa:ethereum/ethereum
         sudo apt-get update
-        sudo apt-get install geth solc
-      if: startsWith(matrix.os, 'Ubuntu')
+        sudo apt-get install -y autoconf automake libtool pkg-config geth solc
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
     - name: Run Geth
       run: |
-        geth --dev --http --ipcpath /tmp/geth.ipc &
-        disown &
+        geth --dev \
+             --http \
+             --ws \
+             --ipcpath /tmp/geth.ipc \
+             >/tmp/geth.log 2>&1 &
+        echo $! > /tmp/geth.pid
+        sleep 10
     - name: Gem Dependencies
       run: |
-        git submodule update --init
-        bundle install
+        git submodule update --init --recursive
     - name: Run Tests
       run: |
         bundle exec rspec
+    - name: Stop Geth
+      if: always()
+      run: |
+        if [ -f /tmp/geth.pid ]; then
+          kill "$(cat /tmp/geth.pid)" 2>/dev/null || true
+        fi
+    - name: Geth Logs (on failure)
+      if: failure()
+      run: |
+        if [ -f /tmp/geth.log ]; then
+          echo "===== geth log ====="
+          tail -n 200 /tmp/geth.log
+        fi
     - name: Upload coverage to Codecov
       uses: codecov/codecov-action@v5
       with:

data/CHANGELOG.md

@@ -1,6 +1,59 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [0.5.15]
+### Added
+* Implement EIP712 array encoding [#361](https://github.com/q9f/eth.rb/pull/361)
+* Support nested dynamic arrays in ABI [#356](https://github.com/q9f/eth.rb/pull/356)
+* Allow signing transactions with external signatures [#349](https://github.com/q9f/eth.rb/pull/349)
+* Feat: add eip-4844 transactions [#345](https://github.com/q9f/eth.rb/pull/345)
+* Support Solidity custom errors per ERC-6093 [#344](https://github.com/q9f/eth.rb/pull/344)
+* Allow to use chains with id > 4294967295 [#337](https://github.com/q9f/eth.rb/pull/337)
+
+### Changed
+* Harden ABI type parsing [#358](https://github.com/q9f/eth.rb/pull/358)
+* Ensure ABI decoder rejects ZST offsets [#359](https://github.com/q9f/eth.rb/pull/359)
+* Test: decode eip4844 blobs [#360](https://github.com/q9f/eth.rb/pull/360)
+* Abi: decode transaction input [#354](https://github.com/q9f/eth.rb/pull/354)
+* Fix tuple output decoding for contract calls [#353](https://github.com/q9f/eth.rb/pull/353)
+* Add comprehensive Tx module tests [#352](https://github.com/q9f/eth.rb/pull/352)
+* Move error decoding to contract module [#350](https://github.com/q9f/eth.rb/pull/350)
+* Enforce minimal RLP integer decoding [#351](https://github.com/q9f/eth.rb/pull/351)
+* Fix tuple size calculation without components [#348](https://github.com/q9f/eth.rb/pull/348)
+* Docs: update readme [#347](https://github.com/q9f/eth.rb/pull/347)
+* Chore: update development dependencies [#346](https://github.com/q9f/eth.rb/pull/346)
+* Handle hex string inputs in big-endian conversion [#343](https://github.com/q9f/eth.rb/pull/343)
+* Handle uppercase hex prefixes [#339](https://github.com/q9f/eth.rb/pull/339)
+* Add methods to encode function call and decode its result [#334](https://github.com/q9f/eth.rb/pull/334)
+* Docs(util): fix hex? return type [#342](https://github.com/q9f/eth.rb/pull/342)
+* Handle hex input consistently in int_to_big_endian [#341](https://github.com/q9f/eth.rb/pull/341)
+* Fix receiver option spelling [#340](https://github.com/q9f/eth.rb/pull/340)
+* Chore: bump version to 0.5.15 [#333](https://github.com/q9f/eth.rb/pull/333)
+
+## [0.5.14]
+### Added
+* Add ability to decode event parameters using ABI reference. [#328](https://github.com/q9f/eth.rb/pull/328)
+* Add support for EIP-7702 transactions  [#320](https://github.com/q9f/eth.rb/pull/320)
+* Eth/abi: implement packed encoder [#310](https://github.com/q9f/eth.rb/pull/310)
+
+### Changed
+* Chore: run rufo, add docs [#332](https://github.com/q9f/eth.rb/pull/332)
+* Spec/client: fix nonce too low error handling in spec [#331](https://github.com/q9f/eth.rb/pull/331)
+* Move the tests that are failing due to a geth upgrade to pending  [#330](https://github.com/q9f/eth.rb/pull/330)
+* Spec/client: don't require any rpc api token for tests [#326](https://github.com/q9f/eth.rb/pull/326)
+* Build(deps): bump JamesIves/github-pages-deploy-action from 4.7.2 to 4.7.3 [#327](https://github.com/q9f/eth.rb/pull/327)
+* Eth/eip712: prepare tests for packed encoding [#216](https://github.com/q9f/eth.rb/pull/216)
+* Spec/solidity: mute system call output [#319](https://github.com/q9f/eth.rb/pull/319)
+* Updated nesting of describe blocks in the EIP-1559 spec. [#318](https://github.com/q9f/eth.rb/pull/318)
+* Update README.md [#317](https://github.com/q9f/eth.rb/pull/317)
+* Docs: update README.md [#314](https://github.com/q9f/eth.rb/pull/314)
+* Gem: update copyright headers [#312](https://github.com/q9f/eth.rb/pull/312)
+* Build(deps): bump JamesIves/github-pages-deploy-action from 4.7.1 to 4.7.2 [#309](https://github.com/q9f/eth.rb/pull/309)
+* Spec: switch from infura to drpc [#308](https://github.com/q9f/eth.rb/pull/308)
+* Ci: update ruby version [#307](https://github.com/q9f/eth.rb/pull/307)
+* Gem: bump version to 0.5.14 [#305](https://github.com/q9f/eth.rb/pull/305)
+* Docs: update changelog [#304](https://github.com/q9f/eth.rb/pull/304)
+
 ## [0.5.13]
 ### Changed
 * Eth/api: update to latest available go-ethereum apis [#301](https://github.com/q9f/eth.rb/pull/301)

data/CODE_OF_CONDUCT.md

@@ -115,8 +115,6 @@ community.
 
 ## Attribution
 
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 2.1, available at
-[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
-Community Impact Guidelines were inspired by
-[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org),
+version 2.1, available at [v2.1](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html).
+Community Impact Guidelines were inspired by Mozilla's code of conduct enforcement ladder.

data/Gemfile

@@ -3,14 +3,14 @@
 source "https://rubygems.org"
 
 group :test, :development do
-  gem "bundler", "~> 2.4"
+  gem "bundler", "~> 2.5"
   gem "pry", "~> 0.15"
   gem "rake", "~> 13.2"
-  gem "rdoc", "~> 6.9"
+  gem "rdoc", "~> 6.13"
   gem "rspec", "~> 3.13"
   gem "rufo", "~> 0.18"
   gem "simplecov", "~> 0.22"
-  gem "simplecov-cobertura", "~> 2.1"
+  gem "simplecov-cobertura", "~> 3.0"
   gem "yard", "~> 0.9"
 end
 

data/README.md

@@ -10,9 +10,7 @@
 [![GitHub release (latest by date)](https://img.shields.io/github/v/release/q9f/eth.rb)](https://github.com/q9f/eth.rb/releases)
 [![Gem](https://img.shields.io/gem/v/eth)](https://rubygems.org/gems/eth)
 [![Gem](https://img.shields.io/gem/dt/eth)](https://rubygems.org/gems/eth)
-[![Visitors](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2Fq9f%2Feth.rb&count_bg=%2379C83D&title_bg=%23555555&icon=rubygems.svg&icon_color=%23FF0000&title=visitors&edge_flat=false)](https://hits.seeyoufarm.com)
 [![codecov](https://codecov.io/gh/q9f/eth.rb/branch/main/graph/badge.svg?token=IK7USBPBZY)](https://codecov.io/gh/q9f/eth.rb)
-[![Maintainability](https://api.codeclimate.com/v1/badges/469e6f66425198ad7614/maintainability)](https://codeclimate.com/github/q9f/eth.rb/maintainability)
 [![Top Language](https://img.shields.io/github/languages/top/q9f/eth.rb?color=red)](https://github.com/q9f/eth.rb/pulse)
 [![Yard Doc API](https://img.shields.io/badge/documentation-API-blue)](https://q9f.github.io/eth.rb)
 [![Usage Wiki](https://img.shields.io/badge/usage-WIKI-blue)](https://github.com/q9f/eth.rb/wiki)
@@ -34,11 +32,15 @@ What you get:
 - [x] EIP-2028 Call-data intrinsic gas cost estimates (plus access lists)
 - [x] EIP-2718 Ethereum Transaction Envelopes (and types)
 - [x] EIP-2930 Ethereum Type-1 Transactions (with access lists)
+- [x] EIP-4844 Ethereum Type-3 Transactions (with shard blobs, up to 9 blobs per block)
+- [x] EIP-7702 Ethereum Type-4 Transactions (with authorization lists)
 - [x] ABI-Encoder and Decoder (including type parser)
+- [x] Packed ABI-Encoder for Solidity smart contracts
 - [x] RLP-Encoder and Decoder (including sedes)
-- [x] RPC-Client (IPC/HTTP) for Execution-Layer APIs
+- [x] RPC-Client (IPC/HTTP/WS) for Execution-Layer APIs
 - [x] Solidity bindings (compile contracts from Ruby)
 - [x] Full smart-contract support (deploy, transact, and call)
+- [x] ERC-6093 custom Solidity errors
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -74,10 +76,10 @@ yard doc
 The goal is to have 100% API documentation available.
 
 ## Testing
-The test suite expects working local HTTP and IPC endpoints with a prefunded developer account, e.g.:
+The test suite expects working local HTTP, WS, and IPC endpoints with a prefunded developer account, e.g.:
 
 ```shell
-geth --dev --http --ipcpath /tmp/geth.ipc &
+geth --dev --http --ws --ipcpath /tmp/geth.ipc &
 ```
 
 To run tests, simply use `rspec`. Note, that the Ethereum test fixtures are also required.
@@ -88,7 +90,7 @@ bundle install
 rspec
 ```
 
-The goal is to have 100% specification coverage for all code inside this gem.
+The goal is to have 100% unit-test coverage for all code inside this gem.
 
 ## Contributing
 Pull requests are welcome! To contribute, please consider the following:

data/SECURITY.md

@@ -10,8 +10,8 @@ later.
 
 | Gem            | Version | Supported          |
 | -------------- | ------- | ------------------ |
-| `eth`          | 0.5.x   | :white_check_mark: |
-| `eth`          | < 0.5   | :x:                |
+| `eth`          | >= 0.5  | :white_check_mark: |
+| `eth`          | <  0.5  | :x:                |
 | `ethereum`     | _any_   | :x:                |
 | `ethereum-abi` | _any_   | :x:                |
 | `rlp`          | _any_   | :x:                |

data/eth.gemspec

@@ -50,8 +50,17 @@ Gem::Specification.new do |spec|
   spec.add_dependency "rbsecp256k1", "~> 6.0"
 
   # openssl for encrypted key derivation
-  spec.add_dependency "openssl", ">= 2.2", "< 4.0"
+  spec.add_dependency "openssl", "~> 3.3"
+
+  # base64 is required explicitly in Ruby >= 3.4
+  spec.add_dependency "base64", "~> 0.1"
 
   # scrypt for encrypted key derivation
   spec.add_dependency "scrypt", "~> 3.0"
+
+  # bls12-381 for BLS signatures and pairings
+  spec.add_dependency "bls12-381", "~> 0.3"
+
+  # httpx for HTTP/2 and persistent connections
+  spec.add_dependency "httpx", "~> 1.6"
 end

data/lib/eth/abi/decoder.rb

@@ -31,59 +31,91 @@ module Eth
       # @return [String] the decoded data for the type.
       # @raise [DecodingError] if decoding fails for type.
       def type(type, arg)
-        if %w(string bytes).include?(type.base_type) and type.sub_type.empty?
-          # Case: decoding a string/bytes
-          if type.dimensions.empty?
-            l = Util.deserialize_big_endian_to_int arg[0, 32]
-            data = arg[32..-1]
-            raise DecodingError, "Wrong data size for string/bytes object" unless data.size == Util.ceil32(l)
-
-            # decoded strings and bytes
-            data[0, l]
-            # Case: decoding array of string/bytes
-          else
-            l = Util.deserialize_big_endian_to_int arg[0, 32]
+        if %w(string bytes).include?(type.base_type) and type.sub_type.empty? and type.dimensions.empty?
+          l = Util.deserialize_big_endian_to_int arg[0, 32]
+          data = arg[32..-1]
+          raise DecodingError, "Wrong data size for string/bytes object" unless data.size == Util.ceil32(l)
 
-            # Decode each element of the array
-            (1..l).map do |i|
-              pointer = Util.deserialize_big_endian_to_int arg[i * 32, 32] # Pointer to the size of the array's element
-              data_l = Util.deserialize_big_endian_to_int arg[32 + pointer, 32] # length of the element
-              type(Type.parse(type.base_type), arg[pointer + 32, Util.ceil32(data_l) + 32])
-            end
-          end
-        elsif type.base_type == "tuple"
+          # decoded strings and bytes
+          data[0, l]
+        elsif type.base_type == "tuple" && type.dimensions.empty?
           offset = 0
-          data = {}
+          result = []
           raise DecodingError, "Cannot decode tuples without known components" if type.components.nil?
-          type.components.each do |c|
-            if c.dynamic?
-              pointer = Util.deserialize_big_endian_to_int arg[offset, 32] # Pointer to the size of the array's element
-              data_len = Util.deserialize_big_endian_to_int arg[pointer, 32] # length of the element
 
-              data[c.name] = type(c, arg[pointer, Util.ceil32(data_len) + 32])
+          head_offset = 0
+          dynamic_offsets = []
+          type.components.each_with_index do |component, index|
+            if component.dynamic?
+              raise DecodingError, "Offset out of bounds" if head_offset + 32 > arg.size
+              pointer = Util.deserialize_big_endian_to_int arg[head_offset, 32]
+              dynamic_offsets << [index, pointer]
+              head_offset += 32
+            else
+              size = component.size
+              raise DecodingError, "Offset out of bounds" if head_offset + size > arg.size
+              head_offset += size
+            end
+          end
+
+          dynamic_ranges = tuple_dynamic_ranges(dynamic_offsets, arg.size, head_offset)
+
+          type.components.each_with_index do |component, index|
+            if component.dynamic?
+              pointer, next_offset = dynamic_ranges[index]
+              raise DecodingError, "Offset out of bounds" if pointer > arg.size || next_offset > arg.size
+              raise DecodingError, "Offset out of bounds" if next_offset < pointer
+              result << type(component, arg[pointer, next_offset - pointer])
               offset += 32
             else
-              size = c.size
-              data[c.name] = type(c, arg[offset, size])
+              size = component.size
+              raise DecodingError, "Offset out of bounds" if offset + size > arg.size
+              result << type(component, arg[offset, size])
               offset += size
             end
           end
-          data
-        elsif type.dynamic?
+          result
+        elsif type.dynamic? && !type.dimensions.empty? && type.dimensions.last == 0
           l = Util.deserialize_big_endian_to_int arg[0, 32]
           nested_sub = type.nested_sub
 
-          # ref https://github.com/ethereum/tests/issues/691
-          raise NotImplementedError, "Decoding dynamic arrays with nested dynamic sub-types is not implemented for ABI." if nested_sub.dynamic?
-
-          # decoded dynamic-sized arrays
-          (0...l).map { |i| type(nested_sub, arg[32 + nested_sub.size * i, nested_sub.size]) }
+          if nested_sub.dynamic?
+            raise DecodingError, "Wrong data size for dynamic array" unless arg.size >= 32 + 32 * l
+            offsets = (0...l).map do |i|
+              off = Util.deserialize_big_endian_to_int arg[32 + 32 * i, 32]
+              raise DecodingError, "Offset out of bounds" if off < 32 * l || off > arg.size - 64
+              off
+            end
+            offsets.each_with_index.map do |off, index|
+              start = 32 + off
+              stop = index + 1 < offsets.length ? 32 + offsets[index + 1] : arg.size
+              raise DecodingError, "Offset out of bounds" if stop > arg.size || stop < start
+              type(nested_sub, arg[start, stop - start])
+            end
+          else
+            raise DecodingError, "Wrong data size for dynamic array" unless arg.size >= 32 + nested_sub.size * l
+            # decoded dynamic-sized arrays with static sub-types
+            (0...l).map { |i| type(nested_sub, arg[32 + nested_sub.size * i, nested_sub.size]) }
+          end
         elsif !type.dimensions.empty?
-          l = type.dimensions.first
+          l = type.dimensions.last
           nested_sub = type.nested_sub
 
-          # decoded static-size arrays
-          (0...l).map { |i| type(nested_sub, arg[nested_sub.size * i, nested_sub.size]) }
+          if nested_sub.dynamic?
+            raise DecodingError, "Wrong data size for static array" unless arg.size >= 32 * l
+            offsets = (0...l).map do |i|
+              off = Util.deserialize_big_endian_to_int arg[32 * i, 32]
+              raise DecodingError, "Offset out of bounds" if off < 32 * l || off > arg.size - 32
+              off
+            end
+            offsets.each_with_index.map do |off, i|
+              size = (i + 1 < offsets.length ? offsets[i + 1] : arg.size) - off
+              type(nested_sub, arg[off, size])
+            end
+          else
+            # decoded static-size arrays with static sub-types
+            (0...l).map { |i| type(nested_sub, arg[nested_sub.size * i, nested_sub.size]) }
+          end
         else
 
           # decoded primitive types
@@ -108,7 +140,9 @@ module Eth
             size = Util.deserialize_big_endian_to_int data[0, 32]
 
             # decoded dynamic-sized array
-            data[32..-1][0, size]
+            decoded = data[32..-1][0, size]
+            decoded.force_encoding(Encoding::UTF_8)
+            decoded
           else
 
             # decoded static-sized array
@@ -148,6 +182,27 @@ module Eth
           raise DecodingError, "Unknown primitive type: #{type.base_type}"
         end
       end
+
+      private
+
+      # Computes the byte ranges for dynamic tuple components.
+      #
+      # @param offsets [Array<Array(Integer, Integer)>] list of tuples containing the component index and pointer.
+      # @param total_size [Integer] total number of bytes available for the tuple.
+      # @param head_size [Integer] size in bytes of the tuple head.
+      # @return [Hash{Integer=>Array(Integer, Integer)}] mapping component index to a [start, stop) range.
+      # @raise [DecodingError] if the encoded offsets overlap or leave the tuple head.
+      def tuple_dynamic_ranges(offsets, total_size, head_size)
+        ranges = {}
+        sorted = offsets.sort_by { |(_, pointer)| pointer }
+        sorted.each_with_index do |(index, pointer), idx|
+          raise DecodingError, "Offset out of bounds" if pointer < head_size || pointer > total_size
+          next_pointer = idx + 1 < sorted.length ? sorted[idx + 1][1] : total_size
+          raise DecodingError, "Offset out of bounds" if next_pointer < pointer || next_pointer > total_size
+          ranges[index] = [pointer, next_pointer]
+        end
+        ranges
+      end
     end
   end
 end