Fix MerkleProof generation in tests and add some documentation (#2585)

2021-03-12 22:41:54 +01:00
parent 682def9f89
commit 82e3ec3afe
2 changed files with 12 additions and 6 deletions
--- a/contracts/utils/cryptography/MerkleProof.sol
+++ b/contracts/utils/cryptography/MerkleProof.sol
@ -3,7 +3,13 @@
 pragma solidity ^0.8.0;

 /**
- * @dev These functions deal with verification of Merkle trees (hash trees),
+ * @dev These functions deal with verification of Merkle Trees proofs.
+ *
+ * The proofs can be generated using the JavaScript library
+ * https://github.com/miguelmota/merkletreejs[merkletreejs].
+ * Note: the hashing algorithm should be keccak256 and pair sorting should be enabled.
+ *
+ * See `test/utils/cryptography/MerkleProof.test.js` for some examples.
 */
 library MerkleProof {
    /**