Bid Beasts

First Flight #49
Beginner FriendlyFoundrySolidityNFT
100 EXP
View results
Submission Details
Severity: low
Valid

Documentation / Implementation Mismatch: endAuction vs settleAuction

Root + Impact

Description

The documentation specifies that auctions should be finalized through a function named endAuction(tokenId).
However, the actual implementation uses a function named settleAuction(tokenId) with equivalent logic.

This naming discrepancy can cause confusion for integrators, auditors, and users relying on the documentation.
Developers expecting endAuction will not find the function in the codebase, leading to incorrect assumptions about functionality.

// Root cause in the codebase
// Documentation states: endAuction(tokenId)
// Code implementation provides:
@> function settleAuction(uint256 tokenId) external isListed(tokenId) { ... }

Risk

Likelihood:

  • Occurs whenever developers or auditors reference the documentation to interact with or review the contract.

  • Likely to affect integration tests, dApp frontends, or audits that expect an endAuction function.

Impact:

  • Documentation-driven users may fail to finalize auctions if they call a non-existent function.

  • Causes trust and usability issues, though no direct financial loss occurs.

Proof of Concept

A developer following the documentation would attempt:

market.endAuction(TOKEN_ID);

This will fail since no such function exists in the contract.
The correct call is:

market.settleAuction(TOKEN_ID);

Recommended Mitigation

Update documentation to match the actual implementation:

- After 3 days, anyone can call endAuction(tokenId) to finalize the auction.
+ After 3 days, anyone can call settleAuction(tokenId) to finalize the auction.
Updates

Lead Judging Commences

cryptoghost Lead Judge
2 months ago
cryptoghost Lead Judge 2 months ago
Submission Judgement Published
Validated
Assigned finding tags:

BidBeasts Marketplace: Improper Documentation

Documentation for BidBeasts Marketplace is incomplete or inaccurate, potentially leading to misconfigurations or security misunderstandings.

Support

FAQs

Can't find an answer? Chat with us on Discord, Twitter or Linkedin.

Give us feedback!