CodeHawks Escrow Contract - Competition Details
Cyfrin
Foundry
40,000 USDC
View results
Previous Next
Submission Details
Severity: gas

NatSpec documentation for function is missing

codeslide

Summary

The Solidity documentation recommends "that Solidity contracts are fully annotated using NatSpec for all public interfaces (everything in the ABI)."

Vulnerability Details

There are 7 instances of this issue.

View 7 Instances
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 Link Instance Count Instance Links
Escrow.sol 7 135,139,143,147,151,155,159

Impact

Decreased readability/maintainability of project source code, increased complexity of automated testing, and a reduced contract user experience.

Tools Used

baudit: a custom static code analysis tool; manual review

Recommendations

NatSpec documentation should be used for improved readability, a better user experience, enhanced auditability, enablement of automated testing and verification, and to promote standardization and interoperability.

Support

FAQs

Can't find an answer? Chat with us on Discord, Twitter or Linkedin.