Open code423n4 opened 2 years ago
The address arguments of the below events can be made indexed.
https://github.com/code-423n4/2022-05-backd/blob/main/protocol/contracts/tokenomics/FeeBurner.sol#L29 https://github.com/code-423n4/2022-05-backd/blob/main/protocol/interfaces/vendor/ICvxLocker.sol#L54 https://github.com/code-423n4/2022-05-backd/blob/main/protocol/contracts/tokenomics/Minter.sol#L58 https://github.com/code-423n4/2022-05-backd/blob/main/protocol/contracts/zaps/PoolMigrationZap.sol#L18
https://github.com/code-423n4/2022-05-backd/blob/main/protocol/contracts/utils/CvxMintAmount.sol#L10-L12
Many functions have no NatSpec comments at all. Even the functions which have NatSpec comments are missing @param, @return values.
Just a few examples. Below functions have no NatSpec: https://github.com/code-423n4/2022-05-backd/blob/main/protocol/contracts/tokenomics/KeeperGauge.sol#L110 https://github.com/code-423n4/2022-05-backd/blob/main/protocol/contracts/utils/CvxMintAmount.sol#L16 https://github.com/code-423n4/2022-05-backd/blob/main/protocol/contracts/tokenomics/AmmGauge.sol#L56
Informational and valid
Personally don't mind either option
Valid and non-critical
Each event can have up to three indexed fields.
The address arguments of the below events can be made indexed.
Lines of code
https://github.com/code-423n4/2022-05-backd/blob/main/protocol/contracts/tokenomics/FeeBurner.sol#L29 https://github.com/code-423n4/2022-05-backd/blob/main/protocol/interfaces/vendor/ICvxLocker.sol#L54 https://github.com/code-423n4/2022-05-backd/blob/main/protocol/contracts/tokenomics/Minter.sol#L58 https://github.com/code-423n4/2022-05-backd/blob/main/protocol/contracts/zaps/PoolMigrationZap.sol#L18
Use scientific notation (for example; 1E9) for large multiples of 10 to improve readability
Lines of code
https://github.com/code-423n4/2022-05-backd/blob/main/protocol/contracts/utils/CvxMintAmount.sol#L10-L12
Missing NatSpec comments
Many functions have no NatSpec comments at all. Even the functions which have NatSpec comments are missing @param, @return values.
Lines of code
Just a few examples. Below functions have no NatSpec: https://github.com/code-423n4/2022-05-backd/blob/main/protocol/contracts/tokenomics/KeeperGauge.sol#L110 https://github.com/code-423n4/2022-05-backd/blob/main/protocol/contracts/utils/CvxMintAmount.sol#L16 https://github.com/code-423n4/2022-05-backd/blob/main/protocol/contracts/tokenomics/AmmGauge.sol#L56