Review of superseded feature

[martinkersner]

Description

Review for #2314

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

📝 Walkthrough

📝 Walkthrough

Walkthrough

The pull request introduces several modifications to the SubmissionProxy contract, focusing on improving submission functionality and error handling. Key updates include making two mappings public for better external access, renaming and adding error types for clearer submission failure reasons, and renaming the submitStrict method to submitStrictBatch with expanded functionality. A new method for single submissions, submitStrictSingle, and a batch update method, updatePrices, have also been added, enhancing the contract's data integrity and submission process.

Changes

File Path	Change Summary
contracts/v0.2/src/SubmissionProxy.sol	- Updated visibility of thresholds and lastSubmissionTimes mappings to public. - Renamed submitStrict to submitStrictBatch. - Added submitStrictSingle method. - Added updatePrices method. - Renamed submitSingle to updatePrice.

Possibly related PRs

• (Contract) SubmissionProxy update #1890: This PR introduces new error types and modifies the submitStrict and submitSingle functions, which are directly related to the changes made in the main PR regarding error handling and submission functionality.
• Test for submitStrict method #2215: This PR provides a testing framework for the submitStrict method, which is relevant as it tests the functionality that has been updated in the main PR, ensuring that the new logic is validated through tests.

Suggested reviewers

• nick-bisonai

🐰 In the meadow, where changes bloom,
A contract dances, dispelling the gloom.
With mappings public, submissions in line,
Errors renamed, all working fine.
New methods added, like hops in the air,
A joyful update, with love and care! 🌼

---

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>, please review it.
  • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @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 using 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.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

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]

Caution

Inline review comments failed to post. This is likely due to GitHub's limits when posting large numbers of comments.

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (2)

contracts/v0.2/src/SubmissionProxy.sol (2)

436-470: Refactor to reduce code duplication between submitStrictSingle and updatePrice

The submitStrictSingle function shares significant logic with updatePrice. Consider refactoring common code into a private helper function to improve maintainability and reduce duplication.

---

Line range hint 509-539: Redundant supersession check in updatePrice function

The check at lines 538-540:

if (lastSubmissionTimes[_feedHash] >= _timestamp) {
    return;
}

is redundant since the same condition is already evaluated at lines 510-512. Removing this redundant code will streamline the function and improve efficiency.

Apply this diff to remove the redundant code:

             revert InvalidProof();
         }
-        if (lastSubmissionTimes[_feedHash] >= _timestamp) {
-            return;
-        }
         feeds[_feedHash].submit(_answer);
         lastSubmissionTimes[_feedHash] = _timestamp;

🛑 Comments failed to post (1)

contracts/v0.2/src/SubmissionProxy.sol (1)

436-470: 🛠️ Refactor suggestion

Ensure reentrancy safety when calling external contracts

The call to feeds[_feedHash].submit(_answer); involves interacting with external contracts. Consider implementing reentrancy guards to protect against potential reentrancy attacks, especially if the submit function in the Feed contracts is not controlled.

[nick-bisonai]

LGTM!