Submission Details
Severity:
NatSpec documentation for `function` is missing
Summary
NatSpec documentation for function is missing
Vulnerability Details
It is recommended that Solidity contracts are fully annotated using NatSpec for all public interfaces (everything in the ABI). It is clearly stated in the Solidity official documentation. In complex projects such as Defi, the interpretation of all functions and their arguments and returns is important for code readability and auditability.source
File: /src/Escrow.sol
135: function getPrice() external view returns (uint256) {
139: function getTokenContract() external view returns (IERC20) {
143: function getBuyer() external view returns (address) {
147: function getSeller() external view returns (address) {
151: function getArbiter() external view returns (address) {
155: function getArbiterFee() external view returns (uint256) {
159: function getState() external view returns (State) {
File: /src/IEscrow.sol
49: function getPrice() external view returns (uint256);
51: function getTokenContract() external view returns (IERC20);
53: function getBuyer() external view returns (address);
55: function getSeller() external view returns (address);
57: function getArbiter() external view returns (address);
59: function getArbiterFee() external view returns (uint256);
61: function getState() external view returns (State);
Impact
Informational
Tools Used
Manual
Recommendations
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.