Omniscia 0xPhase Audit
Element Code Style Findings
Element Code Style Findings
ETN-01C: Multiple Top-Level Declarations
Type | Severity | Location |
---|---|---|
Code Style | Element.sol:L10, L16 |
Description:
The referenced file contains multiple top-level declarations that decrease the legibility of the codebase.
Example:
proxy/utils/Element.sol
10interface IElement {11 /// @notice Gets the DB contract12 /// @return The DB contract13 function db() external view returns (IDB);14}15
16abstract contract Element is IElement {
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 (3dd3d7bf0c2693b2f9c23bacedfa420393f7ea84):
The IElement
interface as well as ElementStorage
struct have been relocated to a dedicated IElement.sol
file that is imported by the Element.sol
codebase, optimizing the code's maintainability.