Omniscia Tren Finance Audit
PriceFeedL2 Static Analysis Findings
PriceFeedL2 Static Analysis Findings
PFL-01S: Illegible Numeric Value Representations
Type | Severity | Location |
---|---|---|
Code Style | PriceFeedL2.sol:L14, L17 |
Description:
The linked representations of numeric literals are sub-optimally represented decreasing the legibility of the codebase.
Example:
14uint256 public constant SEQUENCER_BORROWING_DELAY_SECONDS = 3600;
Recommendation:
To properly illustrate each 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 (f6f1ad0b8f24a96ade345db1dd05a1878eb0f761):
The Tren Finance team evaluated this exhibit but opted to acknowledge it in the current iteration of the codebase.