IntervalVirtualLockMultiplierFacetStorage Code Style Findings

IVM-01C: Inefficient Code Structure

Type	Severity	Location
Gas Optimization		IntervalVirtualLockMultiplierFacetStorage.sol:L226-L229, L232-L234, L236

Description:

The referenced statements will break the for loop that attempts to find the timelock period range that the timelock specified falls in and will return the multiplier after evaluating whether it is zero which accommodates for the case whereby no multiplier has been identified.

Example:

Copy
225for (uint256 i = 1; i < length; i++) {
226    if (timeLockPeriod < timeLockPeriods[i]) {
227        multiplier = campaignInfoLocal.timeLockMultipliers[i - 1];
228        break;
229    }
230}
231
232if (multiplier == 0) {
233    multiplier = campaignInfoLocal.timeLockMultipliers[length - 1];
234}
235
236return multiplier;

Recommendation:

We advise the overall code to be optimized by returning the timeLockMultipliers[i - 1] value directly, and by omitting the if branch evaluating whether the multiplier is 0 as the multiplier would be guaranteed to be zero at that point permitting the timeLockMultipliers[length - 1] value to be yielded directly.

Alleviation (b64b659786cf3c84bea52feb3a69f546ba3601f0):

The code was updated as advised reducing its gas cost under all invocation scenarios.

IVM-02C: Non-Standard Storage Slot Definition

Type	Severity	Location
Standard Conformity		IntervalVirtualLockMultiplierFacetStorage.sol:L55

Description:

The referenced declaration will define a storage slot for use by a facet of the system's main EIP-2535 Diamond, however, the way it is declared does not adhere to the latest standards.

Example:

Copy
53/// @dev Unique identifier for the storage slot where the Layout struct is stored.
54bytes32 internal constant STORAGE_SLOT =
55    keccak256("evergonlabs.Staking.virtualLockMultiplier.storage.IntervalVirtualLockMultiplierFacetStorage");

Recommendation:

We advise the EIP-7201 name-spaced layout approach to be adhered to similarly to OpenZeppelin and other relevant standard libraries, ensuring consistency among the ecosystem's widely utilized libraries and conforming to the latest standards.

Alleviation (b64b659786cf3c84bea52feb3a69f546ba3601f0):

The referenced slot definition has been updated to its standardized EIP-7201 representation, addressing this exhibit.

IVM-03C: Repetitive Value Literal

Type	Severity	Location
Code Style		IntervalVirtualLockMultiplierFacetStorage.sol:L108

Description:

The linked value literal is repeated across the codebase multiple times.

Example:

Copy
108if (GeneralStorage.layout().campaignsInfo[campaignId].state != 1) {

Recommendation:

We advise it to be set to a constant variable instead, optimizing the legibility of the codebase.

In case the constant has already been declared, we advise it to be properly re-used across the code.

Alleviation (b64b659786cf3c84bea52feb3a69f546ba3601f0):

The referenced literal has been properly introduced as part of the GeneralStakingStorage declarations and specifically as an ON_CREATION state, addressing this exhibit.