CodeHawks Escrow Contract - Competition Details

QA

Layout Order [1]

• The best-practices for layout within a contract is the following order: state variables, events, modifiers, constructor and functions.

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

natSpec missing [2]

Some functions are missing @params or @returns. Specification Format.” These are written with a triple slash (///) or a double asterisk block(/** ... */) directly above function declarations or statements to generate documentation in JSON format for developers and end-users. It is recommended that Solidity contracts are fully annotated using NatSpec for all public interfaces (everything in the ABI). These comments contain different types of tags:

• @title: A title that should describe the contract/interface @author: The name of the author (for contract, interface)

• @notice: Explain to an end user what this does (for contract, interface, function, public state variable, event)

• @dev: Explain to a developer any extra details (for contract, interface, function, state variable, event)

• @param: Documents a parameter (just like in doxygen) and must be followed by parameter name (for function, event)

• @return: Documents the return variables of a contract’s function (function, public state variable)

• @inheritdoc: Copies all missing tags from the base function and must be followed by the contract name (for function, public state variable)

• @custom…: Custom tag, semantics is application-defined (for everywhere)

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

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