Omniscia Vendor Finance Audit

VendorLicenseEngine Static Analysis Findings

VendorLicenseEngine Static Analysis Findings

VLE-01S: Illegible Numeric Value Representation

Description:

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

Example:

contracts/VendorLicenseEngine.sol
60if (_discount < 0 || _discount > 1000000) revert InvalidDiscount();

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 special separator character has been introduced as advised, properly illustrating the decimal accuracy of the percentage value.