Submission Details
Severity:
Missing Documentation (Informational)
Summary
The LibChop::chop function is missing documentation for the supply parameter.
Vulnerability Detail
The @param documentation for the supply parameter is missing in the LibChop::chop function.
Impact
The absence of documentation for the supply parameter could lead to confusion for developers trying to understand the function's usage. It may also increase the likelihood of errors or unintended behavior when interacting with the function.
Code Snippet
function chop(
address unripeToken,
uint256 amount,
uint256 supply
) internal returns (address underlyingToken, uint256 underlyingAmount) {
AppStorage storage s = LibAppStorage.diamondStorage();
underlyingAmount = LibUnripe.getPenalizedUnderlying(unripeToken, amount, supply);
// remove the underlying amount and decrease s.recapitalized if token is unripe LP
LibUnripe.removeUnderlying(unripeToken, underlyingAmount);
underlyingToken = s.u[unripeToken].underlyingToken;
}
Tool used
Manual Review
Recommendation
Add the following documentation for the supply parameter:
* @param supply The total supply of the unripeToken.
Prize pool breakdown
Total prize
21,000 USDC
nSLOC
1,10419 USDC / LOC
17,900 USDC
1,000 USDC
2,100 USDC
Live
The contest is live. Earn rewards by submitting a finding.
Appeals
This is your time to appeal against judgements on your submissions.
Appeals Review
Appeals are being carefully reviewed by our judges.