Submission Details
Severity:
NatSpec @param and @return tags are missing
Summary
It is recommended that Solidity contracts are fully annotated using NatSpec for all public interfaces (everything in the ABI).
Vulnerability Details
There are some functions that are missing NatSpec annotations. Especially in the EscrowFactory.sol contract where we have very important functions which are not explaining what each of the parameters is doing with @param tag.
Also, it's important to use @return tag to specify what is being returned by the function
Instances: 4
EscrowFactory.sol
function newEscrow(
uint256 price,
IERC20 tokenContract,
address seller,
address arbiter,
uint256 arbiterFee,
bytes32 salt
) external returns (IEscrow)
function computeEscrowAddress(
bytes memory byteCode,
address deployer,
uint256 salt,
uint256 price,
IERC20 tokenContract,
address buyer,
address seller,
address arbiter,
uint256 arbiterFee
) public pure returns (address)
Escrow.sol
modifier inState(State expectedState)
function resolveDispute(
uint256 buyerAward
) external onlyArbiter nonReentrant inState(State.Disputed)
Tools Used
Documentation
Recommendations
Tag above mentioned functions with necessary NatSpec tags.
Prize pool breakdown
Total prize
40,000 USDC
nSLOC
186215 USDC / LOC
37,000 USDC
3,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.