PythOracle Static Analysis Findings

POE-01S: Illegible Numeric Value Representations

Type	Severity	Location
Code Style		PythOracle.sol:L15, L74

Description:

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

Example:

Copy
15uint256 internal constant MAX_CONF_WIDTH = 500;

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 relevant variable has been omitted per remediation conducted for exhibit POE-01M rendering this recommendation no longer applicable.