Add note about memory manipulation in MerkleTree (#5213)

Signed-off-by: Hadrien Croubois <hadrien.croubois@gmail.com>
This commit is contained in:
Ernesto García
2024-09-19 09:08:52 -06:00
committed by Hadrien Croubois
parent e6cb351824
commit 824a295d1c

View File

@ -70,7 +70,10 @@ library MerkleTree {
* should be pushed to it using the custom push function, which should be the same one as used during the setup. * should be pushed to it using the custom push function, which should be the same one as used during the setup.
* *
* IMPORTANT: Providing a custom hashing function is a security-sensitive operation since it may * IMPORTANT: Providing a custom hashing function is a security-sensitive operation since it may
* compromise the soundness of the tree. Consider using functions from {Hashes}. * compromise the soundness of the tree.
*
* NOTE: Consider verifying that the hashing function does not manipulate the memory state directly and that it
* follows the Solidity memory safety rules. Otherwise, it may lead to unexpected behavior.
*/ */
function setup( function setup(
Bytes32PushTree storage self, Bytes32PushTree storage self,