Omniscia Tangible Audit
LzAppUpgradeable Static Analysis Findings
LzAppUpgradeable Static Analysis Findings
LAU-01S: Illegible Numeric Value Representation
Type | Severity | Location |
---|---|---|
Code Style | LzAppUpgradeable.sol:L42 |
Description:
The linked representation of a numeric literal is sub-optimally represented decreasing the legibility of the codebase.
Example:
42uint256 public constant DEFAULT_PAYLOAD_SIZE_LIMIT = 10000;
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 (47fbf62bbbf2409ff0baf9a18a2945466cb2a576):
The referenced value literal has been updated in its representation to 10_000
in accordance with the recommendation's underscore style, addressing this exhibit.