extra comment

matter-labs · Feb 6, 2025 · a839f07 · a839f07
1 parent 6240860
commit a839f07
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/l1-contracts/contracts/state-transition/chain-interfaces/IMailbox.sol b/l1-contracts/contracts/state-transition/chain-interfaces/IMailbox.sol
@@ -124,7 +124,9 @@ interface IMailbox is IZKChainBase {
         uint256 _l2GasPerPubdataByteLimit
     ) external view returns (uint256);
 
-    /// Proves that a certain leaf was included as part of the log merkle tree.
+    /// @dev Proves that a certain leaf was included as part of the log merkle tree.
+    /// @dev Warning, this function returns true if a section of the proof with the 
+    /// @dev corresponding intermediate node hash is provided instead of the full merkle proof and leaf.
     function proveL2LeafInclusion(
         uint256 _batchNumber,
         uint256 _batchRootMask,