Omniscia Maverick Protocol Audit

Constants Static Analysis Findings

Constants Static Analysis Findings

CST-01S: Illegible Numeric Value Representation

TypeSeverityLocation
Code StyleConstants.sol:L18

Description:

The linked representation of a numeric literal is sub-optimally represented decreasing the legibility of the codebase.

Example:

v2-common/contracts/libraries/Constants.sol
18uint256 constant MAX_TICK = 322378; // max price 1e14 in D18 scale

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 (175f8c39b19df69134add3aa8a2a042ce3047763):

The referenced value literal has been updated in its representation to 322_378 in accordance with the recommendation's underscore style, addressing this exhibit.