15,000 USDC
View results
Submission Details
Severity: gas

Missing or incomplete natspec

Description

Throughout the project there are functionalities that are only partially documented by natspec.

Some examples on of missing function natpsec:
https://github.com/Cyfrin/2023-07-foundry-defi-stablecoin/blob/main/src/DSCEngine.sol#L87

Or constants:
https://github.com/Cyfrin/2023-07-foundry-defi-stablecoin/blob/main/src/libraries/OracleLib.sol#L21

Or events:
https://github.com/Cyfrin/2023-07-foundry-defi-stablecoin/blob/main/src/libraries/OracleLib.sol#L19

Each and every function, event, contract, error, constant and code line should be accompanied by adequate documentation

Recommend Mitigation

Add natsec in the code where missing.

Support

FAQs

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