Skip to content

⚡️ Optimize MerkleTreeLib #1438

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Vectorized merged 2 commits into from
Jun 23, 2025
Merged

⚡️ Optimize MerkleTreeLib #1438

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c316767
T
Vectorized Jun 23, 2025
75b218e
T
Vectorized Jun 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 15 additions & 23 deletions src/utils/MerkleTreeLib.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,22 +113,14 @@ library MerkleTreeLib {
pure
returns (bytes32[] memory result)
{
uint256 nodeIndex;
/// @solidity memory-safe-assembly
assembly {
result := mload(0x40)
let n := mload(t)
if iszero(lt(leafIndex, sub(n, shr(1, n)))) {
mstore(0x00, 0x7a856a38) // `MerkleTreeOutOfBoundsAccess()`.
revert(0x1c, 0x04)
}
let o := add(result, 0x20)
for { let i := sub(n, add(1, leafIndex)) } i { i := shr(1, sub(i, 1)) } {
mstore(o, mload(add(t, shl(5, add(i, shl(1, and(1, i)))))))
o := add(o, 0x20)
}
mstore(0x40, o) // Allocate memory.
mstore(result, shr(5, sub(o, add(result, 0x20)))) // Store length.
nodeIndex := sub(n, add(1, leafIndex))
if iszero(lt(leafIndex, sub(n, shr(1, n)))) { nodeIndex := not(0) }
}
result = nodeProof(t, nodeIndex);
}

/// @dev Returns the proof for the node at `nodeIndex`.
Expand Down Expand Up @@ -167,16 +159,12 @@ library MerkleTreeLib {
function gen(leafIndices_, t_, proof_, flags_) -> _flagsLen, _proofLen {
let q_ := mload(0x40) // Circular buffer.
let c_ := mload(leafIndices_) // Capacity of circular buffer.
let e_ := mload(leafIndices_) // End index of circular buffer.
let e_ := c_ // End index of circular buffer.
let b_ := 0 // Start index of circular buffer.
if iszero(e_) {
mstore(0x00, 0xe9729976) // `MerkleTreeInvalidLeafIndices()`.
revert(0x1c, 0x04)
}
for {
let n_ := mload(t_) // Num nodes.
let l_ := sub(n_, shr(1, n_)) // Num leafs.
let p_ := 0
let p_ := not(0)
let i_ := 0
} 1 {} {
let j_ := mload(add(add(leafIndices_, 0x20), shl(5, i_))) // Leaf index.
Expand All @@ -185,7 +173,7 @@ library MerkleTreeLib {
mstore(0x00, 0x7a856a38) // `MerkleTreeOutOfBoundsAccess()`.
revert(0x1c, 0x04)
}
if iszero(or(iszero(i_), gt(j_, p_))) {
if iszero(sgt(j_, p_)) {
mstore(0x00, 0xe9729976) // `MerkleTreeInvalidLeafIndices()`.
revert(0x1c, 0x04)
}
Expand All @@ -204,17 +192,21 @@ library MerkleTreeLib {
_flagsLen := add(_flagsLen, 0x20)
let f_ := and(eq(s_, add(1, mload(add(q_, shl(5, mod(b_, c_)))))), lt(b_, e_))
b_ := add(b_, f_)
if flags_ { mstore(add(flags_, _flagsLen), f_) }
if iszero(f_) {
_proofLen := add(_proofLen, 0x20)
if flags_ { mstore(add(proof_, _proofLen), mload(add(t_, shl(5, s_)))) }
_proofLen := add(_proofLen, shl(5, iszero(f_)))
if flags_ {
mstore(add(flags_, _flagsLen), f_)
mstore(mul(iszero(f_), add(proof_, _proofLen)), mload(add(t_, shl(5, s_))))
}
mstore(add(q_, shl(5, mod(e_, c_))), shr(1, sub(j_, 1)))
e_ := add(e_, 1)
}
_proofLen := shr(5, _proofLen)
_flagsLen := shr(5, _flagsLen)
}
if iszero(mload(leafIndices)) {
mstore(0x00, 0xe9729976) // `MerkleTreeInvalidLeafIndices()`.
revert(0x1c, 0x04)
}
let flagsLen, proofLen := gen(leafIndices, t, 0x00, 0x00)
proof := mload(0x40)
mstore(proof, proofLen)
Expand Down
9 changes: 9 additions & 0 deletions test/MerkleTreeLib.t.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,4 +216,13 @@ contract MerkleTreeLibTest is SoladyTest {
gathered[i] = leafs[indices[i]];
}
}

function testMultiProofRevertsForEmptyLeafs() public {
vm.expectRevert(MerkleTreeLib.MerkleTreeInvalidLeafIndices.selector);
this.multiProofRevertsForEmptyLeafs();
}

function multiProofRevertsForEmptyLeafs() public pure {
(new bytes32[](1)).leafsMultiProof(new uint256[](0));
}
}