Token Static Analysis Findings

TNE-01S: Illegible Numeric Value Representation

Type	Severity	Location
Code Style		Token.sol:L75

Description:

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

Example:

Copy
75uint256 _toSend = _available * _distribution[i].shareBps / 10_000;

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:

The Mean Finance team stated that they wish to retain the current underscore position given that they wish to represent 10_000 as a large number.

We would like to note that given that 10_000 is meant to indicate a "percentage" (BPS), its legibility would be increased by representing it as 100_00 thus indicating that up to two decimal points of accuracy are supported by the shareBps entries.