NavOracle Static Analysis Findings

NOE-01S: Illegible Numeric Value Representation

Type	Severity	Location
Code Style		NavOracle.sol:L99

Description:

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

Example:

Copy
99if (diff * 10_000 > prev * maxPpsMoveBps) revert TooLargeMove();

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 Altura Trade team evaluated this exhibit but opted to acknowledge it in the current iteration of the codebase.

NOE-02S: Multiple Top-Level Declarations

Type	Severity	Location
Code Style		NavOracle.sol: • I-1: L7 • I-2: L13

Description:

The referenced file contains multiple top-level declarations that decrease the legibility of the codebase.

Example:

Copy
7interface INavOracle {
8    function pricePerShare() external view returns (uint256 pps1e18, uint256 lastUpdatedAt);
9    function isValid() external view returns (bool);
10    function maxOracleStaleness() external view returns (uint256);
11}
12
13contract NavOracle is INavOracle, AccessControl, Pausable {

Recommendation:

We advise all highlighted top-level declarations to be split into their respective code files, avoiding unnecessary imports as well as increasing the legibility of the codebase.

Alleviation:

The Altura Trade team evaluated this exhibit but opted to acknowledge it in the current iteration of the codebase.