fix(audit): Merkle library infos #1597
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nadir-akhtar
force-pushed
the
release-dev/merkle-audit-fixes
branch
from
cf11051 to
e87f933
Compare
…proof.length is 0
…l other functions
nadir-akhtar
force-pushed
the
nadir/merkle-infos
branch
from
6710b90 to
5d53a67
Compare
ypatil12
reviewed
Aug 7, 2025
ypatil12
reviewed
Aug 7, 2025
ypatil12
reviewed
Aug 7, 2025
ypatil12
reviewed
Aug 7, 2025
ypatil12
reviewed
Aug 7, 2025
Collaborator
|
For each function should we add where (if at all) we use it elsewhere in the protocol. Example: @dev Used by `RewardsCoordinator.xyz` |
Collaborator
Author
|
We do indeed capture L-03 within these fixes -- a consequence of closing I-03 |
Collaborator
Author
|
@ypatil12 Rather than specify in the file, since that could get unwieldy (especially for others referencing / copying the library), I've created a new documentation file for the library -- think it captures what you're looking for? |
nadir-akhtar
added a commit
that referenced
this pull request
Aug 12, 2025
<!--
🚨 ATTENTION! 🚨
This PR template is REQUIRED. PRs not following this format will be
closed without review.
Requirements:
- PR title must follow commit conventions:
https://www.conventionalcommits.org/en/v1.0.0/
- Label your PR with the correct type (e.g., 🐛 Bug, ✨ Enhancement, 🧪
Test, etc.)
- Provide clear and specific details in each section
-->
**Motivation:**
As part of an audit for the Merkle library, several low and
informational findings were found. This PR consolidates all
informational findings to fix, as well as additional commits for
findings discovered along the way, with a specific commit for each
finding.
All Lows are separated into individual PRs into the
[release-dev/merkle-audit-fixes](https://github.com/Layr-Labs/eigenlayer-contracts/tree/release-dev/merkle-audit-fixes)
branch
**Modifications:**
* Completely uplifted natspec, matching current EigenLayer quality and
standards
* Four new error codes:
* `InvalidIndex` for indices outside of the Merkle tree's max index
* `LeavesNotPowerOfTwo` for leaves (particularly for SHA256 functions)
that don't match the expected length condition
* `NoLeaves` for an empty `leaves` array
* `NotEnoughLeaves` for leaves (particularly for SHA256 functions) that
are not 2 or greater
* Explicit return in `processInclusionProofKeccak` for 0 length proofs
to return the leaf
* Requirement in `processInclusionProof(Keccak|Sha256)` that the index
is 0, i.e. the index was for a leaf within the tree
* Refactoring in `merkleize(Sha256|Keccak)` and `getProofKeccak` of
logic for readability and performance
* Newly added `getProofSha256` to mirror `getProofKeccak` to reduce
burden of producing roots offchain
* Newly added `isPowerOfTwo` helper function
* Newly added documentation file for the Merkle library
**Result:**
* Improved documentation/natspec
* Four new error codes
* Refactored and simplified code
* Newly added `getProofSha256` and `isPowerOfTwo` functions
* Updated and added unit tests
nadir-akhtar
added a commit
that referenced
this pull request
Aug 13, 2025
<!--
🚨 ATTENTION! 🚨
This PR template is REQUIRED. PRs not following this format will be
closed without review.
Requirements:
- PR title must follow commit conventions:
https://www.conventionalcommits.org/en/v1.0.0/
- Label your PR with the correct type (e.g., 🐛 Bug, ✨ Enhancement, 🧪
Test, etc.)
- Provide clear and specific details in each section
-->
**Motivation:**
In response to a recent audit report, we are closing out Lows and Infos
related to the Merkle library.
**Modifications:**
* [fix(audit): Merkle library infos
(#1597)](a98493f)
* [fix(L-01): prevent uninitialized roots from being used
(#1586)](30ec964)
**Result:**
Cleaner, safer code
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation:
As part of an audit for the Merkle library, several low and informational findings were found. This PR consolidates all informational findings to fix, as well as additional commits for findings discovered along the way, with a specific commit for each finding.
All Lows are separated into individual PRs into the release-dev/merkle-audit-fixes branch
Modifications:
InvalidIndexfor indices outside of the Merkle tree's max indexLeavesNotPowerOfTwofor leaves (particularly for SHA256 functions) that don't match the expected length conditionNoLeavesfor an emptyleavesarrayNotEnoughLeavesfor leaves (particularly for SHA256 functions) that are not 2 or greaterprocessInclusionProofKeccakfor 0 length proofs to return the leafprocessInclusionProof(Keccak|Sha256)that the index is 0, i.e. the index was for a leaf within the treemerkleize(Sha256|Keccak)andgetProofKeccakof logic for readability and performancegetProofSha256to mirrorgetProofKeccakto reduce burden of producing roots offchainisPowerOfTwohelper functionResult:
getProofSha256andisPowerOfTwofunctions