feat: add OpenZeppelin Pausable to all auction contracts as circuit b…

[Rav1Chauhan]

…reaker

Addressed Issues:

Implements OpenZeppelin Pausable to add an emergency circuit breaker mechanism across all auction contracts.
Fixes #53

Changes Made

• Inherited Pausable and Ownable where required
• Added whenNotPaused modifier to:
  • createAuction()
  • bid()
  • withdraw()
  • claim()
• Added pause() and unpause() functions restricted to owner

Why This Matters

If a vulnerability is discovered mid-auction, maintainers can pause the contract to prevent further damage and protect user funds.

Testing

• Contracts compile successfully
• Verified pausing blocks bid and auction functions

Screenshots/Recordings:

N/A — This change introduces backend safety improvements (Pausable circuit breaker) and does not modify frontend behavior.

Additional Notes:

This PR implements OpenZeppelin's Pausable contract across all auction types to introduce an emergency circuit breaker mechanism.

If a vulnerability or exploit is discovered mid-auction, maintainers can now pause the contract to prevent further damage and protect user funds.

The following functions are protected using whenNotPaused:

createAuction()

bid()

withdraw()

claim()

Additionally:

Contracts now inherit Ownable

Added pause() and unpause() functions restricted to the owner

This change improves operational safety while maintaining full backward compatibility.

All contracts compile successfully using Hardhat.

Checklist

• [ x] My PR addresses a single issue, fixes a single bug or makes a single improvement.
• [ x] My code follows the project's code style and conventions.
• If applicable, I have made corresponding changes or additions to the documentation.
• If applicable, I have made corresponding changes or additions to tests.
• [ x] My changes generate no new warnings or errors.
• [x ] I have joined the Stability Nexus's Discord server and I will share a link to this PR with the project maintainers there.
• [x ] I have read the Contribution Guidelines.
• [ x] Once I submit my PR, CodeRabbit AI will automatically review it and I will address CodeRabbit's comments.

AI Usage Disclosure

Check one of the checkboxes below:

• This PR does not contain AI-generated code at all.
• This PR contains AI-generated code. I have tested the code locally and I am responsible for it.

I have used the following AI models and tools: TODO

⚠️ AI Notice - Important!

We encourage contributors to use AI tools responsibly when creating Pull Requests. While AI can be a valuable aid, it is essential to ensure that your contributions meet the task requirements, build successfully, include relevant tests, and pass all linters. Submissions that do not meet these standards may be closed without warning to maintain the quality and integrity of the project. Please take the time to understand the changes you are proposing and their impact.

Summary by CodeRabbit

Release Notes

• New Features

  • Added pause/unpause controls for contract administrators to temporarily halt auction operations when needed.
  • Expanded auction metadata visibility with additional descriptive information across auction types.

• Chores

  • Updated OpenZeppelin dependencies to the latest version.

[coderabbitai]

📝 Walkthrough

Walkthrough

Implements an emergency pause mechanism across all auction contracts (AllPayAuction, EnglishAuction, Exponential/Linear/Logarithmic/Vickrey variations) by adding OpenZeppelin's Ownable and Pausable modules. All contracts now include owner-controlled pause/unpause functions and guard key operations with the whenNotPaused modifier. OpenZeppelin dependency upgraded from ^5.2.0 to ^5.4.0.

Changes

Cohort / File(s)	Summary
Pause & Ownership Control contracts/AllPayAuction.sol, contracts/EnglishAuction.sol, contracts/ExponentialReverseDutchAuction.sol, contracts/LinearReverseDutchAuction.sol, contracts/LogarithmicReverseDutchAuction.sol, contracts/VickreyAuction.sol	Updated all auction contracts to inherit from Ownable and Pausable; constructor now initializes Ownable with deployer; added public pause() and unpause() functions restricted to onlyOwner; guarded createAuction, bid, withdraw, and claim with whenNotPaused modifier for emergency circuit-breaker functionality.
Metadata & AuctionData Expansion contracts/AllPayAuction.sol, contracts/ExponentialReverseDutchAuction.sol, contracts/LogarithmicReverseDutchAuction.sol	Extended AuctionData struct in select contracts to include descriptive fields (description, imgUrl, auctioneer, auctionType, auctionedToken, auctionedTokenIdOrAmount, biddingToken, minimumBid); updated AuctionCreated event signatures to emit new metadata fields.
Dependency Update package.json	Upgraded @openzeppelin/contracts from ^5.2.0 to ^5.4.0; minor formatting adjustments to scripts section.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

• fix: align test suite with contract interfaces and fix constructor args #15 — Updates test files to match constructor and function signature changes introduced in this PR.
• Simplified contract logic and readablitiy #8 — Modifies the same auction contracts and shared AuctionData/event structures, overlapping in createAuction and bid function changes.
• Smart Contract Development – Major Refactor and Feature Expansion #6 — Applies modifications to the same set of auction contracts and shared interfaces.

Suggested reviewers

• ceilican
• yogesh0509

Poem

🐰 A pause button appears, oh what a sight,
When bugs rear their heads in the dead of night,
The owner cries "halt!" and the contract obeys,
No more runaway bids in those chaotic days,
Safety's the name of the game we now play! 🛡️

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The PR title clearly indicates the main change: adding OpenZeppelin Pausable as a circuit breaker to auction contracts, which aligns with the primary objective of implementing an emergency pause mechanism.
Linked Issues check	✅ Passed	All coding requirements from issue #53 are met: Pausable inherited by all auction contracts, whenNotPaused applied to bid/withdraw/claim/createAuction, pause/unpause functions added with onlyOwner restriction.
Out of Scope Changes check	✅ Passed	The PR includes a minor OpenZeppelin dependency bump from 5.2.0 to 5.4.0 in package.json, which is necessary for Pausable support. All other changes are directly related to implementing the pausable circuit breaker requirement.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

contracts/LinearReverseDutchAuction.sol (1)

62-112: ⚠️ Potential issue | 🟠 Major

createAuction is not pause-gated in this contract.

This leaves a bypass for new auctions even when the circuit breaker is active. Add whenNotPaused to align with the PR objective.

✅ Suggested fix

-    ) external nonEmptyString(name) nonZeroAddress(auctionedToken) nonZeroAddress(biddingToken) {
+    ) external whenNotPaused nonEmptyString(name) nonZeroAddress(auctionedToken) nonZeroAddress(biddingToken) {

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@contracts/LinearReverseDutchAuction.sol` around lines 62 - 112, createAuction
is missing the pause guard so new auctions can be created while the circuit
breaker is active; add the whenNotPaused modifier to the createAuction function
declaration (alongside the existing nonEmptyString and nonZeroAddress modifiers)
so the function uses the Pausable circuit breaker (ensure the contract already
uses Pausable/whenNotPaused). Target the createAuction(...) function and append
whenNotPaused to its modifier list.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Outside diff comments:
In `@contracts/LinearReverseDutchAuction.sol`:
- Around line 62-112: createAuction is missing the pause guard so new auctions
can be created while the circuit breaker is active; add the whenNotPaused
modifier to the createAuction function declaration (alongside the existing
nonEmptyString and nonZeroAddress modifiers) so the function uses the Pausable
circuit breaker (ensure the contract already uses Pausable/whenNotPaused).
Target the createAuction(...) function and append whenNotPaused to its modifier
list.

---

ℹ️ Review info

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between fd82d51 and 244d77a.

⛔ Files ignored due to path filters (1)

• package-lock.json is excluded by !**/package-lock.json

📒 Files selected for processing (7)

• contracts/AllPayAuction.sol
• contracts/EnglishAuction.sol
• contracts/ExponentialReverseDutchAuction.sol
• contracts/LinearReverseDutchAuction.sol
• contracts/LogarithmicReverseDutchAuction.sol
• contracts/VickreyAuction.sol
• package.json