Omniscia Boson Protocol Audit

OfferHandlerFacet Code Style Findings

OfferHandlerFacet Code Style Findings

OHF-01C: Invalid NatSpec Requirements

TypeSeverityLocation
Code StyleOfferHandlerFacet.sol:
I-1: L41
I-2: L94

Description:

The referenced requirements have been regressed based on PR#946, rendering them to be misleading as to the code's implementation.

Example:

contracts/protocol/facets/OfferHandlerFacet.sol
79* Reverts if:
80* - The offers region of protocol is paused
81* - Number of elements in offers, offerDates, offerDurations, disputeResolverIds, agentIds and feeLimits do not match
82* - For any offer:
83* - Caller is not an assistant
84* - Valid from date is greater than valid until date
85* - Valid until date is not in the future
86* - Both voucher expiration date and voucher expiration period are defined
87* - Neither of voucher expiration date and voucher expiration period are defined
88* - Voucher redeemable period is fixed, but it ends before it starts
89* - Voucher redeemable period is fixed, but it ends before offer expires
90* - Dispute period is less than minimum dispute period
91* - Resolution period is not between the minimum and the maximum resolution period
92* - Voided is set to true
93* - Available quantity is set to zero
94* - Offer type is discovery and the price is not set to zero

Recommendation:

We advise them to be omitted, optimizing the code's documentation.

Alleviation:

The invalid comments have been removed as advised.