Omniscia Evergon Labs Audit

OmnichainNonFungibleTokenDO Static Analysis Findings

OmnichainNonFungibleTokenDO Static Analysis Findings

ONF-01S: Illegible Numeric Value Representations

TypeSeverityLocation
Code StyleOmnichainNonFungibleTokenDO.sol:
I-1: L34
I-2: L37

Description:

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

Example:

contracts/dataobjects/omnichain/OmnichainNonFungibleTokenDO.sol
34uint128 private constant OMNICHAIN_INCREASE_BALANCE_GAS_LIMIT = 400000;

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 (c6b23c23d8bcd8cce85049ad959cbd711a37126b):

The referenced value literals have been updated in their representation to 400_000, and 20_000 respectively in accordance with the recommendation's underscore style, addressing this exhibit.