PositionSettingsRegistry Static Analysis Findings

PSR-01S: Illegible Numeric Value Representations

Type	Severity	Location
Code Style		PositionSettingsRegistry.sol:L41, L42

Description:

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

Example:

Copy
41uint256 constant MAX_SLIPPAGE_BP = 500;

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 (6ab7af3bb495b817ffec469255ea679b1813eecb):

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

PSR-02S: Inexistent Sanitization of Input Addresses

Type	Severity	Location
Input Sanitization		PositionSettingsRegistry.sol:L49-L57

Description:

The linked function(s) accept address arguments yet do not properly sanitize them.

Impact:

The presence of zero-value addresses, especially in constructor implementations, can cause the contract to be permanently inoperable. These checks are advised as zero-value inputs are a common side-effect of off-chain software related bugs.

Example:

Copy
49constructor(
50    SickleFactory _factory,
51    ConnectorRegistry connectorRegistry,
52    address timelockAdmin
53) TimelockAdmin(timelockAdmin) {
54    factory = _factory;
55    _connectorRegistry = connectorRegistry;
56    emit ConnectionRegistrySet(address(connectorRegistry));
57}

Recommendation:

We advise some basic sanitization to be put in place by ensuring that each address specified is non-zero.

Alleviation (6ab7af3bb495b817ffec469255ea679b1813eecb):

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

PSR-03S: Inexistent Visibility Specifiers

Type	Severity	Location
Code Style		PositionSettingsRegistry.sol:L41, L42, L47

Description:

The linked variables have no visibility specifier explicitly set.

Example:

Copy
41uint256 constant MAX_SLIPPAGE_BP = 500;

Recommendation:

We advise them to be set so to avoid potential compilation discrepancies in the future as the current behaviour is for the compiler to assign one automatically which may deviate between pragma versions.

Alleviation (6ab7af3bb495b817ffec469255ea679b1813eecb):

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