OfferBase Static Analysis Findings

OBE-01S: Illegible Numeric Value Representation

Type	Severity	Location
Code Style		OfferBase.sol:L194

Description:

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

Example:

Copy
19410000;

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 (2b9f60b6c3323fd234b570089ceff924cdb5851c):

The Boson Protocol has stated that they do not follow this naming convention elsewhere and as such wish to retain the current one in place.