Omniscia Boson Protocol Audit
OfferHandlerFacet Code Style Findings
OfferHandlerFacet Code Style Findings
OHF-01C: Invalid NatSpec Requirements
| Type | Severity | Location |
|---|---|---|
| Code Style | ![]() | OfferHandlerFacet.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 paused81* - Number of elements in offers, offerDates, offerDurations, disputeResolverIds, agentIds and feeLimits do not match82* - For any offer:83* - Caller is not an assistant84* - Valid from date is greater than valid until date85* - Valid until date is not in the future86* - Both voucher expiration date and voucher expiration period are defined87* - Neither of voucher expiration date and voucher expiration period are defined88* - Voucher redeemable period is fixed, but it ends before it starts89* - Voucher redeemable period is fixed, but it ends before offer expires90* - Dispute period is less than minimum dispute period91* - Resolution period is not between the minimum and the maximum resolution period92* - Voided is set to true93* - Available quantity is set to zero94* - Offer type is discovery and the price is not set to zeroRecommendation:
We advise them to be omitted, optimizing the code's documentation.
Alleviation:
The invalid comments have been removed as advised.
