Beginner FriendlyFoundry
100 EXP
View results
Submission Details
Severity: low
Invalid

Incorrect NatSpec

Summary

This is a Non Critical but its so loud in the code
Wrong NatSpec. Contracts lack rich NatSpec in many parts as well

Vulnerability Details

/*
* @notice This allows only the owner to retrieve the password.
* @param newPassword The new password to set.
*/
function getPassword() external view returns (string memory) {
if (msg.sender != s_owner) {
revert PasswordStore__NotOwner();
}
return s_password;
}

Function does not take a parameter but NatSpec incorrectly says it takes @param newPassword

Impact

Can affect auditability, readability, and maintainability and even security if its updated to take in password such that person requesting password enters the password etc

Tools Used

Manual Analysis

Recommendations

Ensure NatSpec is rich and correct throughout contract

Updates

Lead Judging Commences

inallhonesty Lead Judge
about 2 years ago
inallhonesty Lead Judge about 2 years ago
Submission Judgement Published
Invalidated
Reason: Non-acceptable severity

Support

FAQs

Can't find an answer? Chat with us on Discord, Twitter or Linkedin.