Omniscia Steer Protocol Audit
BaseLiquidityManager Static Analysis Findings
BaseLiquidityManager Static Analysis Findings
BLM-01S: Illegible Numeric Value Representations
Type | Severity | Location |
---|---|---|
Code Style | BaseLiquidityManager.sol:L70, L79, L81, L83 |
Description:
The linked representations of numeric literals are sub-optimally represented decreasing the legibility of the codebase.
Example:
70uint256 internal constant DIVISOR100 = 1_00;
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 (6513a21a002d422e298719b22f73a4559dfd4663):
The Steer Protocol team evaluated this exhibit and opted to selectively apply the numeric representation style where they deemed appropriate.
As such, we consider this exhibit alleviated based on the preferences of the Steer Protocol team.