search

Cyfrin / 2023-07-escrow

16 stars 12 forks source link

NatSpec `@return` argument is missing #856

Open codehawks-bot opened 1 year ago

codehawks-bot commented 1 year ago

NatSpec @return argument is missing

Severity

Gas Optimization / Informational

Relevant GitHub Links

https://github.com/Cyfrin/2023-07-escrow/tree/main/src/Escrow.sol

https://github.com/Cyfrin/2023-07-escrow/tree/main/src/EscrowFactory.sol

https://github.com/Cyfrin/2023-07-escrow/tree/main/src/IEscrow.sol

Summary

NatSpec @return argument is missing

Vulnerability Details

Instances (15):

File: src/Escrow.sol

144:     function getPrice() external view returns (uint256) {

148:     function getTokenContract() external view returns (IERC20) {

152:     function getBuyer() external view returns (address) {

156:     function getSeller() external view returns (address) {

160:     function getArbiter() external view returns (address) {

164:     function getArbiterFee() external view returns (uint256) {

168:     function getState() external view returns (State) {

Link to code - https://github.com/Cyfrin/2023-07-escrow/tree/main/src/Escrow.sol

File: src/EscrowFactory.sol

57:     function computeEscrowAddress(

Link to code - https://github.com/Cyfrin/2023-07-escrow/tree/main/src/EscrowFactory.sol

File: src/IEscrow.sol

51:     function getPrice() external view returns (uint256);

53:     function getTokenContract() external view returns (IERC20);

55:     function getBuyer() external view returns (address);

57:     function getSeller() external view returns (address);

59:     function getArbiter() external view returns (address);

61:     function getArbiterFee() external view returns (uint256);

63:     function getState() external view returns (State);

Link to code - https://github.com/Cyfrin/2023-07-escrow/tree/main/src/IEscrow.sol

Tools Used

Manual Code Review

Recommendations

Use NatSpec @return