DeFiFoundrySolidity
16,653 OP
View results
Submission Details
Severity: low
Invalid

Codebase is having functions with Missing Natspec

Vulnerability Details

There are functions in the codebase which are not having Natspec

Instance 1:

https://github.com/Cyfrin/2024-12-alchemix/blob/82798f4891e41959eef866bd1d4cb44fc1e26439/src/StrategyArb.sol#L42

function setRouter(address _router) external onlyManagement {

Instance 2:

https://github.com/Cyfrin/2024-12-alchemix/blob/82798f4891e41959eef866bd1d4cb44fc1e26439/src/StrategyArb.sol#L81

function _swapUnderlyingToAsset(uint256 _amount, uint256 minOut, IRamsesRouter.route[] calldata _path) internal {

Instance 3:

https://github.com/Cyfrin/2024-12-alchemix/blob/82798f4891e41959eef866bd1d4cb44fc1e26439/src/StrategyArb.sol#L122

function balanceDeployed() public view returns (uint256) {

Instance 4:
https://github.com/Cyfrin/2024-12-alchemix/blob/82798f4891e41959eef866bd1d4cb44fc1e26439/src/StrategyArb.sol#L214

function claimableBalance() public view returns (uint256) {

Instance 5:

https://github.com/Cyfrin/2024-12-alchemix/blob/82798f4891e41959eef866bd1d4cb44fc1e26439/src/StrategyArb.sol#L218

function unexchangedBalance() public view returns (uint256) {

Instance 6:

https://github.com/Cyfrin/2024-12-alchemix/blob/82798f4891e41959eef866bd1d4cb44fc1e26439/src/StrategyMainnet.sol#L146

function balanceDeployed() public view returns (uint256) {

Instance 7:

https://github.com/Cyfrin/2024-12-alchemix/blob/82798f4891e41959eef866bd1d4cb44fc1e26439/src/StrategyMainnet.sol#L235

function claimableBalance() public view returns (uint256) {

Instance 8:

https://github.com/Cyfrin/2024-12-alchemix/blob/82798f4891e41959eef866bd1d4cb44fc1e26439/src/StrategyMainnet.sol#L239

function unexchangedBalance() public view returns (uint256) {

Instance 9:

https://github.com/Cyfrin/2024-12-alchemix/blob/82798f4891e41959eef866bd1d4cb44fc1e26439/src/StrategyOp.sol#L135

function balanceDeployed() public view returns (uint256) {

Instance 10:

https://github.com/Cyfrin/2024-12-alchemix/blob/82798f4891e41959eef866bd1d4cb44fc1e26439/src/StrategyOp.sol#L217

function claimableBalance() public view returns (uint256) {

Instance 11:

https://github.com/Cyfrin/2024-12-alchemix/blob/82798f4891e41959eef866bd1d4cb44fc1e26439/src/StrategyOp.sol#L221

function unexchangedBalance() public view returns (uint256) {

Impact:

Incomplete/Missing Natspec can make the codebase harder to understand for the users.

Recommendations

Add minimal Natspec for all the functions.

Updates

Appeal created

inallhonesty Lead Judge 12 months ago
Submission Judgement Published
Invalidated
Reason: Non-acceptable severity

Support

FAQs

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

Give us feedback!