Submission Details
Severity:
NatSpec documentation for function 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 16 instances of this issue.
View 16 Instances
File: src/Beedle.sol
11: constructor() ERC20("Beedle", "BDL") ERC20Permit("Beedle") Ownable(msg.sender) {
36: function mint(address to, uint256 amount) external onlyOwner {
| File Link | Instance Count | Instance Links |
|---|---|---|
| Beedle.sol | 2 | 11,36 |
File: src/Fees.sol
19: constructor(address _weth, address _staking) {
| File Link | Instance Count | Instance Link |
|---|---|---|
| Fees.sol | 1 | 19 |
File: src/Lender.sol
73: constructor() Ownable(msg.sender) {
108: function getPoolId(
109: address lender,
110: address loanToken,
111: address collateralToken
112: ) public pure returns (bytes32 poolId) {
116: function getLoanDebt(uint256 loanId) external view returns (uint256 debt) {
| File Link | Instance Count | Instance Links |
|---|---|---|
| Lender.sol | 3 | 73,108,116 |
File: src/Staking.sol
8: function claim(address) external;
31: constructor(address _token, address _weth) Ownable(msg.sender) {
| File Link | Instance Count | Instance Links |
|---|---|---|
| Staking.sol | 2 | 8,31 |
File: src/interfaces/IERC20.sol
7: function totalSupply() external view returns (uint256);
8: function balanceOf(address account) external view returns (uint256);
9: function transfer(address to, uint256 amount) external returns (bool);
10: function allowance(address owner, address spender) external view returns (uint256);
11: function approve(address spender, uint256 amount) external returns (bool);
12: function transferFrom(address from, address to, uint256 amount) external returns (bool);
| File Link | Instance Count | Instance Links |
|---|---|---|
| IERC20.sol | 6 | 7,8,9,10,11,12 |
File: src/interfaces/ISwapRouter.sol
16: function exactInputSingle(ExactInputSingleParams calldata params) external payable returns (uint256 amountOut);
| File Link | Instance Count | Instance Link |
|---|---|---|
| ISwapRouter.sol | 1 | 16 |
File: src/utils/Ownable.sol
19: function transferOwnership(address _owner) public virtual onlyOwner {
| File Link | Instance Count | Instance Link |
|---|---|---|
| Ownable.sol | 1 | 19 |
Impact
Decreased readability and usability.
Tools Used
baudit: a custom static code analysis tool; manual review
Recommendations
Add NatSpec comments for all public functions.
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.