Omniscia Native Audit

PeripheryPayments Static Analysis Findings

PeripheryPayments Static Analysis Findings

PPS-01S: Illegible Numeric Value Representations

TypeSeverityLocation
Code StylePeripheryPayments.sol:L52, L59, L73, L79

Description:

The linked representations of numeric literals are sub-optimally represented decreasing the legibility of the codebase.

Example:

contracts/libraries/PeripheryPayments.sol
52require(feeBips > 0 && feeBips <= 100, "Fee out of range");

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:

The underscore separator has been adequately introduced to all referenced statements of the codebase as advised.