Foundry DeFi Stablecoin CodeHawks Audit Contest
Cyfrin
DeFiFoundry
15,000 USDC
View results
Previous Next
Submission Details
Severity: gas
Valid

[I-1] NatSpec `@param` is missing

0xbug

Instances (33):

File: https://github.com/Cyfrin/2023-07-foundry-defi-stablecoin/blob/main/src/DSCEngine.sol
​
- 112: constructor(address[] memory tokenAddresses, address[] memory priceFeedAddresses, address dscAddress) {
+ 112: // @param tokenAddresses
​
- 112: constructor(address[] memory tokenAddresses, address[] memory priceFeedAddresses, address dscAddress) {
+ 112: // @param priceFeedAddresses
​
- 112: constructor(address[] memory tokenAddresses, address[] memory priceFeedAddresses, address dscAddress) {
+ 112: // @param dscAddress
​
- 212: function burnDsc(uint256 amount) public moreThanZero(amount) {
+ 212: // @param amount
​
- 272: function _burnDsc(uint256 amountDscToBurn, address onBehalfOf, address dscFrom) private {
+ 272: // @param amountDscToBurn
​
- 272: function _burnDsc(uint256 amountDscToBurn, address onBehalfOf, address dscFrom) private {
+ 272: // @param onBehalfOf
​
- 272: function _burnDsc(uint256 amountDscToBurn, address onBehalfOf, address dscFrom) private {
+ 272: // @param dscFrom
​
- 282: function _redeemCollateral(address from, address to, address tokenCollateralAddress, uint256 amountCollateral)
+ 282: // @param from
​
- 282: function _redeemCollateral(address from, address to, address tokenCollateralAddress, uint256 amountCollateral)
+ 282: // @param to
​
- 282: function _redeemCollateral(address from, address to, address tokenCollateralAddress, uint256 amountCollateral)
+ 282: // @param tokenCollateralAddress
​
- 282: function _redeemCollateral(address from, address to, address tokenCollateralAddress, uint256 amountCollateral)
+ 282: // @param amountCollateral
​
- 297: function _getAccountInformation(address user)
+ 297: // @param user
​
- 310: function _healthFactor(address user) private view returns (uint256) {
+ 310: // @param user
​
- 317: function _revertIfHealthFactorIsBroken(address user) internal view {
+ 317: // @param user
​
- 324: function _calculateHealthFactor(uint256 totalDscMinted, uint256 collateralValueInUsd)
+ 324: // @param totalDscMinted
​
- 324: function _calculateHealthFactor(uint256 totalDscMinted, uint256 collateralValueInUsd)
+ 324: // @param collateralValueInUsd
​
- 340: function getTokenAmountFromUsd(address token, uint256 usdAmountInWei) public view returns (uint256) {
+ 340: // @param token
​
- 340: function getTokenAmountFromUsd(address token, uint256 usdAmountInWei) public view returns (uint256) {
+ 340: // @param usdAmountInWei
​
- 350: function getAccountCollateralValue(address user) public view returns (uint256 totalCollateralValueInUsd) {
+ 350: // @param user
​
- 361: function getUsdValue(address token, uint256 amount) public view returns (uint256) {
+ 361: // @param token
​
- 361: function getUsdValue(address token, uint256 amount) public view returns (uint256) {
+ 361: // @param amount
​
- 369: function getAccountInformation(address user)
+ 369: // @param user
​
- 385: function calculateHealthFactor(uint256 totalDscMinted, uint256 collateralValueInUsd)
+ 385: // @param totalDscMinted
​
- 385: function calculateHealthFactor(uint256 totalDscMinted, uint256 collateralValueInUsd)
+ 385: // @param collateralValueInUsd
​
- 393: function getHealthFactor(address user) external view returns (uint256) {
+ 393: // @param user
​
- 401: function getCollateralTokenPriceFeed(address token) external view returns (address) {
+ 401: // @param token
​
- 417: function getCollateralBalanceOfUser(address user, address token) external view returns (uint256) {
+ 417: // @param user
​
- 417: function getCollateralBalanceOfUser(address user, address token) external view returns (uint256) {
+ 417: // @param token
​
File: src/DecentralizedStableCoin.sol
​
- 46: function burn(uint256 _amount) public override onlyOwner {
+ 46: // @param _amount
​
- 57: function mint(address _to, uint256 _amount) external onlyOwner returns (bool) {
+ 57: // @param _to
​
- 57: function mint(address _to, uint256 _amount) external onlyOwner returns (bool) {
+ 57: // @param _amount
​
File: src/libraries/OracleLib.sol
​
- 21: function staleCheckLatestRoundData(AggregatorV3Interface priceFeed)
+ 21: // @param priceFeed
​
- 35: function getTimeout(AggregatorV3Interface /* chainlinkFeed */ ) public pure returns (uint256) {
+ 35: // @param
​

Support

FAQs

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