Fixes for the Sequencer downtime oracle to correctly detect invalid rounds

[zmanian]

Summary by CodeRabbit

• New Features

  • Enhanced error handling in the SequencerPriceRouter contract with a new error type for invalid oracle rounds.

• Bug Fixes

  • Improved handling of cases where the oracle returns an invalid state, increasing contract reliability.

• Documentation

  • Constructor parameters reformatted for better readability and clarity.

• Tests

  • Expanded testing scenarios to ensure proper function behavior under invalid conditions.

[coderabbitai]

Walkthrough

The changes enhance the SequencerPriceRouter contract's error handling with the addition of a new error type for invalid oracle rounds and improve code readability in the constructor. Updates to the testing suite ensure that scenarios with invalid round conditions are adequately addressed, reinforcing the contract's reliability and simplifying logical flows related to the startedAt variable.

Changes

Files	Change Summary
src/modules/price-router/permutations/SequencerPriceRouter.sol	Added SequencerPriceRouter__InvalidRound error for better error handling; reformatted constructor; updated _runPreFlightCheck to check startedAt.
test/testPriceRouter/SequencerPriceRouter.t.sol	Modified mockStartedAt initialization; enhanced testing for getPriceInUSD with invalid round scenarios; simplified logic for startedAt.

Poem

🐇 In the land of smart contracts, bright and fair,
A new error type dances in the air.
With checks and balances, our code now plays,
Robust and ready for endless days.
Hooray for the changes, let’s hop with glee,
For a future of clarity, come join me! 🎉

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 6d25401 and 6a500d9.

Files selected for processing (2)

• src/modules/price-router/permutations/SequencerPriceRouter.sol (5 hunks)
• test/testPriceRouter/SequencerPriceRouter.t.sol (3 hunks)

Additional comments not posted (6)

src/modules/price-router/permutations/SequencerPriceRouter.sol (3)

16-16: Addition of SequencerPriceRouter__InvalidRound error is appropriate.

The new error type enhances the contract's robustness by allowing precise error handling for invalid oracle rounds.

---

31-37: Constructor formatting changes improve readability.

Listing parameters on separate lines enhances clarity and maintainability.

---

58-60: Enhancement in _runPreFlightCheck improves error handling.

The check for startedAt being zero and reverting with SequencerPriceRouter__InvalidRound ensures invalid oracle data is handled effectively.

test/testPriceRouter/SequencerPriceRouter.t.sol (3)

24-24: Initialization of mockStartedAt to 1 is appropriate.

This ensures that tests do not inadvertently trigger the invalid round condition unless explicitly set.

---

48-56: Test logic for invalid oracle rounds is effective.

The test correctly verifies the new error handling logic by expecting a revert with SequencerPriceRouter__InvalidRound when mockAnswer is 0 and mockStartedAt is 0.

---

91-91: Simplification of startedAt assignment improves clarity.

Directly using mockStartedAt simplifies the logic by removing unnecessary conditional checks.