CodeHawks Escrow Contract - Competition Details

Summary

Code functions and parts lacking or having incomplete rich NatSpec code commenting

Vulnerability Details

IEscrowFactory.sol -> line 10 event missing NatSpec commenting
IEscrow.sol -> lines 20 -22 events missing NatSpec commenting
-> line 43 function missing NatSpec with @param buyerAward
Escrow.sol -> lines 32 constructor missing NatSpec and @param for the constructor inputs
-> lines 82 modifier missing Natspec with @param State expectedState
-> lines 139-161 all view functions missing NatSpec code commenting

Impact

Informational: This impacts code quality, interpretability, readability, maintanability and auditability of code

Tools Used

Manual Analysis

Recommendations

It is recommended that all functions, modifiers, events and other relevant aspects have rich NatSpec commenting detailing notes, params, return values etc. If inheriting can use @inheritdoc to avoid duplication or link to external function with NatSpec