Omniscia Boson Protocol Audit

OfferBase Code Style Findings

OfferBase Code Style Findings

OBE-01C: Invalid NatSpec Requirements

TypeSeverityLocation
Code StyleOfferBase.sol:
• I-1: L33
• I-2: L100

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/bases/OfferBase.sol
89* Reverts if:
90* - Valid from date is greater than valid until date
91* - Valid until date is not in the future
92* - Both fixed voucher expiration date and voucher redemption duration are defined
93* - Neither of fixed voucher expiration date and voucher redemption duration are defined
94* - Voucher redeemable period is fixed, but it ends before it starts
95* - Voucher redeemable period is fixed, but it ends before offer expires
96* - Dispute period is less than minimum dispute period
97* - Resolution period is not between the minimum and the maximum resolution period
98* - Voided is set to true
99* - Available quantity is set to zero
100* - 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.

Prev

MetaTransactionsHandlerFacet.sol (MTH-C)

Next

OfferHandlerFacet.sol (OHF-C)

On this page