chore: add notice in Natspec for isValidSignature

lukso-network · Nov 3, 2023 · fbd6ee0 · fbd6ee0
1 parent c0090c6
commit fbd6ee0
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/contracts/LSP0ERC725Account/LSP0ERC725AccountCore.sol b/contracts/LSP0ERC725Account/LSP0ERC725AccountCore.sol
@@ -725,6 +725,11 @@ abstract contract LSP0ERC725AccountCore is
      * @param signature A signature that can validate the previous parameter (Hash).
      *
      * @return returnedStatus A `bytes4` value that indicates if the signature is valid or not.
+     *
+     * @custom:warning This function does not enforce by default including the address of this contract in the signature digest.
+     * It is recommended that protocols or applications using this contract to include the targeted address (= this contract) in the data to sign.
+     * To ensure that this signature should be valid for a specific LSP0ERC725Account and prevent signatures from the same EOA to be replayed
+     * across different LSP0ERC725Accounts.
      */
     function isValidSignature(
         bytes32 dataHash,

diff --git a/contracts/LSP6KeyManager/LSP6KeyManagerCore.sol b/contracts/LSP6KeyManager/LSP6KeyManagerCore.sol
@@ -152,6 +152,11 @@ abstract contract LSP6KeyManagerCore is
      * If the signer is a controller with the permission `SIGN`, it will return the ERC1271 success value.
      *
      * @return returnedStatus `0x1626ba7e` on success, or `0xffffffff` on failure.
+     *
+     * @custom:warning This function does not enforce by default including the address of this contract in the signature digest.
+     * It is recommended that protocols or applications using this contract to include the targeted address (= this contract) in the data to sign.
+     * To ensure that this signature should be valid for a specific LSP6KeyManager and prevent signatures from the same EOA to be replayed
+     * across different LSP6KeyManager.
      */
     function isValidSignature(
         bytes32 dataHash,