Omniscia Steadefi Audit
Math Static Analysis Findings
Math Static Analysis Findings
MHT-01S: Illegible Numeric Value Representation
Type | Severity | Location |
---|---|---|
Code Style | Math.sol:L11 |
Description:
The linked representation of a numeric literal is sub-optimally represented decreasing the legibility of the codebase.
Example:
11return ((maxValue - min(value0, value1)) * 10000) <= toleranceBps * maxValue;
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 (4325253d6de0ea91c1e9fb9e01d2e7e98f3d83a9):
The file is no longer present in the codebase, rendering this exhibit no longer applicable.