Omniscia Steer Protocol Audit

Code Style

Code Style

During the manual portion of the audit, we identified 23 optimizations that can be applied to the codebase that will decrease the operational cost associated with the execution of a particular function and generally ensure that the project complies with the latest best practices and standards in Solidity.

Additionally, this section of the audit contains any opinionated adjustments we believe the code should make to make it more legible as well as truer to its purpose.

These optimizations are enumerated below:

IDSeverityAddressedTitle
BLM-01CInexistent Error Messages
BLM-02CNon-Standard Gap Declaration
BLM-03CRelocation of Validation Check
BLM-04CSub-Optimal Data Types
DJS-01CImproper Toggle Terminology
IGE-01CInexistent Error Messages
IGT-01CRedundant Duplicate Implementation
ORO-01CDirect Return of Conditional Evaluation
SPL-01CGeneric Typographic Mistake
SRS-01CGeneric Typographic Mistakes
SRS-02CInefficient Mapping System
SRS-03CInefficient mapping Lookups
SGE-01CGeneric Typographic Mistake
STN-01CRedundant Invocation of Getter Function
SRY-01COptimization of Pointer Data Location
SRY-02CSuboptimal Struct Declaration Style
TVR-01CInexistent Error Message
TVR-02CVariable Mutability Specifiers (Immutable)
TVR-03CVariable Optimization
VRY-01CSuboptimal Struct Declaration Style
WRY-01CImproper Emission of Events
WRY-02CInefficient mapping Lookups
WRY-03CInexistent Error Message