Submission Details
Severity:
NatSpec documentation for contract is missing
Summary
The Solidity documentation recommends "that Solidity contracts are fully annotated using NatSpec for all public interfaces (everything in the ABI)." NatSpec documentation should be used for improved readability, a better user experience, enhanced auditability, enablement of automated testing and verification, and to promote standardization and interoperability.
Vulnerability Details
There are 7 instances of this issue.
View 7 Instances
File: src/Beedle.sol
9: contract Beedle is Ownable, ERC20, ERC20Permit, ERC20Votes {
| File Link | Instance Count | Instance Link |
|---|---|---|
| Beedle.sol | 1 | 9 |
File: src/Fees.sol
11: contract Fees {
| File Link | Instance Count | Instance Link |
|---|---|---|
| Fees.sol | 1 | 11 |
File: src/Lender.sol
10: contract Lender is Ownable {
| File Link | Instance Count | Instance Link |
|---|---|---|
| Lender.sol | 1 | 10 |
File: src/Staking.sol
7: interface FeeDistribution {
11: contract Staking is Ownable {
| File Link | Instance Count | Instance Links |
|---|---|---|
| Staking.sol | 2 | 7,11 |
File: src/interfaces/IERC20.sol
4: interface IERC20 {
| File Link | Instance Count | Instance Link |
|---|---|---|
| IERC20.sol | 1 | 4 |
File: src/interfaces/ISwapRouter.sol
4: interface ISwapRouter {
| File Link | Instance Count | Instance Link |
|---|---|---|
| ISwapRouter.sol | 1 | 4 |
Impact
Decreased readability and usability.
Tools Used
baudit: a custom static code analysis tool; manual review
Recommendations
Add contract-level NatSpec comments for all contracts.
Prize pool breakdown
Total prize
20,000 USDC
nSLOC
70628 USDC / LOC
18,000 USDC
2,000 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.