Omniscia Nexera Audit

PerpetuallyReceiveFundsFacetStorage Code Style Findings

PerpetuallyReceiveFundsFacetStorage Code Style Findings

PRS-01C: Inexistent Documentation of Storage Slot

Description:

The referenced STORAGE_SLOT does not have its actual result specified in its in-line documentation as it remains a TO-DO.

Example:

packages/contracts/contracts/internalFacets/receivePhaseFacets/doReceiveFacets/perpetuallyReceiveFunds/PerpetuallyReceiveFundsFacetStorage.sol
17/** ================================================== STORAGE =================================================
18 * @dev Unique identifier for the storage slot where the Layout struct is stored. Derived from the ERC7201 formula.
19 * STORAGE_SLOT: TO-DO
20 */
21bytes32 internal constant STORAGE_SLOT =
22 keccak256(abi.encode(uint256(keccak256("Evergonlabs.Tmi-Tokenizer.storage.PerpetuallyReceiveFundsFacetStorage")) - 1)) &
23 ~bytes32(uint256(0xff));

Recommendation:

We advise the 0xf04c7770b4f02cb482ba5f104c288c0f3c3580ee7e066a42d7060eee9a9c4c00 storage slot to be properly specified in its comments, aiding in debugging of the contract's structure.

Alleviation (d682057ecb0e254069773d64f32c068cedb71e2a):

The correct storage slot has been specified as advised.