Submission Details
Severity:
Add proper headers and comment alignment
Description
Project code style uses a short, and somehwat asymetrical, form of comment header separation. To improve readability, change headers to a more visible version.
Example this header :
/////////////////////
// View functions
/////////////////////
can be rewritten using https://github.com/transmissions11/headers as:
/*//////////////////////////////////////////////////////////////
VIEW FUNCTIONS
//////////////////////////////////////////////////////////////*/
Also, align text to after the @dev tag in comments for better visibility:
Example, align:
/// @dev Sets the Escrow transaction values for `price`, `tokenContract`, `buyer`, `seller`, `arbiter`, `arbiterFee`. All of
/// these values are immutable: they can only be set once during construction and reflect essential deal terms.
/// @dev Funds should be sent to this address prior to its deployment, via create2. The constructor checks that the tokens have
/// been sent to this address.
as
/// @dev Sets the Escrow transaction values for `price`, `tokenContract`, `buyer`, `seller`, `arbiter`, `arbiterFee`. All of
/// these values are immutable: they can only be set once during construction and reflect essential deal terms.
/// @dev Funds should be sent to this address prior to its deployment, via create2. The constructor checks that the tokens have
/// been sent to this address.
Recommend Mitigation
Rewrite all headers using https://github.com/transmissions11/headers.
Rewrite natspec comments to align to 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.