The following functions have inline comments that could be included as part of NatSpec to provide a more robust documentation.
constructor
: Consider using a dev tag to explain what the inputs represent.
DSCEngine::liquidate
: Consider implementing a dev tag to give the mathematical explanation of the how the function works.
DSCEngine::redeemCollateralForDsc
: Consider using a dev tag to explain why the function doesn't checks msg.sender
's health factor.
DSCEngine::_healthFactor
: Consider using a return tag to explain what the function returns.
DSCEngine::_revertIfHealthFactorIsBroken
: Consider using a dev tag to explain how the function works.
DSCEngine::getTokenAmountFromUsd
: Consider using a dev tag to explain the math behind the function and a return tag to explain what it returns.
DSCEngine::getAccountCollateralValue
: Consider using a dev tag to explain the math behind the function and return tag to explain what it returns.
DSCEngine::getUsdValue
: Consider using a dev tag to explain the math behind the function and return tag to explain what it returns.
DSCEngine::_calculateHealthFactor
: This function doesn't provide documentation about the math it performs.
The contest is live. Earn rewards by submitting a finding.
This is your time to appeal against judgements on your submissions.
Appeals are being carefully reviewed by our judges.