Omniscia Evergon Labs Audit
FractionFactory Static Analysis Findings
FractionFactory Static Analysis Findings
FFY-01S: Illegible Numeric Value Representation
| Type | Severity | Location |
|---|---|---|
| Code Style | ![]() | FractionFactory.sol:L29 |
Description:
The linked representation of a numeric literal is sub-optimally represented decreasing the legibility of the codebase.
Example:
29uint128 public constant DEPLOY_GAS_LIMIT = 500000;Recommendation:
To properly illustrate the value's purpose, we advise the following guidelines to be followed.
For values meant to depict fractions with a base of 1e18, we advise fractions to be utilized directly (i.e. 1e17 becomes 0.1e18) as they are supported.
For values meant to represent a percentage base, we advise each value to utilize the underscore (_) separator to discern the percentage decimal (i.e. 10000 becomes 100_00, 300 becomes 3_00 and so on).
Finally, for large numeric values we simply advise the underscore character to be utilized again to represent them (i.e. 1000000 becomes 1_000_000).
Alleviation (c6b23c23d8bcd8cce85049ad959cbd711a37126b):
The referenced value literal has been updated in its representation to 500_000 in accordance with the recommendation's underscore style, addressing this exhibit.
