QA Report #145
Labels
bug
Something isn't working
QA (Quality Assurance)
Assets are not at risk. State handling, function incorrect as to spec, issues with clarity, syntax
[NAZ-N] Line Length
Severity: Informational
Context:
BaseV1-core.sol#L143
,BaseV1-core.sol#L147
,BaseV1-core.sol#L149
,BaseV1-core.sol#L251-L252
,BaseV1-core.sol#L284
,BaseV1-periphery.sol#L495
,BaseV1-periphery.sol#L499
Description:
Max line length must be no more than 120 but many lines are extended past this length.
Recommendation:
Consider cutting down the line length below 120.
[NAZ-N] Function && Variable Naming Convention
Severity Informational
Context:
BaseV1-periphery.sol#L448
,BaseV1-periphery.sol#L525
,BaseV1-periphery.sol#L537
,BaseV1-periphery.sol#L549
,BaseV1-periphery.sol#L579
,BaseV1-periphery.sol#L586
Description:
The linked variables do not conform to the standard naming convention of Solidity whereby functions and variable names(local and state) utilize the
mixedCase
format unless variables are declared asconstant
in which case they utilize theUPPER_CASE_WITH_UNDERSCORES
format. Private variables and functions should lead with anunderscore
.Recommendation:
Consider naming conventions utilized by the linked statements are adjusted to reflect the correct type of declaration according to the Solidity style guide.
[NAZ-N] Missing or Incomplete NatSpec
Severity: Informational
Context:
All Contracts
Description:
Some functions are missing @notice/@dev NatSpec comments for the function, @param for all/some of their parameters and @return for return values. Given that NatSpec is an important part of code documentation, this affects code comprehension, auditability and usability.
Recommendation:
Consider adding in full NatSpec comments for all functions to have complete code documentation for future use.
[NAZ-N] Older Version Pragma
Severity: Informational
Context:
All Contracts
Description:
Using very old versions of Solidity prevents benefits of bug fixes and newer security checks. Using the latest versions might make contracts susceptible to undiscovered compiler bugs.
Recommendation:
Consider using the most recent version.
The text was updated successfully, but these errors were encountered: