Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

rearrange refund validation checks [SLT-185] #3172

Merged
merged 3 commits into from
Sep 26, 2024

Conversation

parodime
Copy link
Collaborator

@parodime parodime commented Sep 23, 2024

Description
rearrange refund validation checks - Check transaction status first then check secondaries

Summary by CodeRabbit

  • New Features

    • Enhanced refund process in the FastBridgeV2 contract with an additional status check to ensure only valid transactions can be refunded.
  • Bug Fixes

    • Enabled execution of previously skipped tests for the refund function, allowing for better verification of expected behaviors under various transaction statuses.

Copy link
Contributor

coderabbitai bot commented Sep 23, 2024

Walkthrough

The pull request introduces modifications to the refund function in the FastBridgeV2 contract, adding a status check to ensure that only transactions in the REQUESTED state can be refunded. Additionally, it updates test cases by removing skip directives, allowing them to run and verify the new revert conditions. These changes ensure proper handling of refunds based on transaction status.

Changes

Files Change Summary
packages/contracts-rfq/contracts/FastBridgeV2.sol Modified the refund function to include a check for bridgeStatuses[transactionId] being BridgeStatus.REQUESTED before processing refunds, with an updated comment for clarity.
packages/contracts-rfq/test/FastBridgeV2.Src.t.sol Replaced ethTx with tokenTx in several test cases and removed skip directives from three test functions, enabling them to execute and verify the expected revert conditions related to the refund function under various transaction statuses.

Possibly related PRs

Suggested labels

size/s, Sol, Typescript

Suggested reviewers

  • ChiTimesChi
  • trajan0x

Poem

In the meadow where bunnies play,
A contract now finds a clearer way.
With checks in place, no more to stray,
Refunds will hop without delay!
So let us cheer, with joy we say,
For code that's bright as a sunny day! 🐰✨


📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 5cac9e0 and 8388836.

📒 Files selected for processing (2)
  • packages/contracts-rfq/contracts/FastBridgeV2.sol (2 hunks)
  • packages/contracts-rfq/test/FastBridgeV2.Src.t.sol (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • packages/contracts-rfq/contracts/FastBridgeV2.sol
  • packages/contracts-rfq/test/FastBridgeV2.Src.t.sol

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
🪧 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.

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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Outside diff range and nitpick comments (1)
packages/contracts-rfq/contracts/FastBridgeV2.sol (1)

265-267: LGTM: Status check added as the first validation.

This change aligns with the PR objective of rearranging refund validation checks. It ensures that only transactions in the REQUESTED state can be refunded, which is a crucial security measure.

Consider improving the error message for clarity.

While the current error message is functional, it could be more specific to help with debugging and understanding the issue.

Consider updating the error message to be more descriptive:

-        if (bridgeStatuses[transactionId] != BridgeStatus.REQUESTED) revert StatusIncorrect();
+        if (bridgeStatuses[transactionId] != BridgeStatus.REQUESTED) revert StatusIncorrect("Refund only allowed for REQUESTED status");

This change would require updating the Errors.sol file to include the new error message.

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between faf9387 and b9f2ed5.

Files selected for processing (2)
  • packages/contracts-rfq/contracts/FastBridgeV2.sol (2 hunks)
  • packages/contracts-rfq/test/FastBridgeV2.Src.t.sol (0 hunks)
Files not reviewed due to no reviewable changes (1)
  • packages/contracts-rfq/test/FastBridgeV2.Src.t.sol
Additional comments not posted (2)
packages/contracts-rfq/contracts/FastBridgeV2.sol (2)

278-278: LGTM: Comment updated for clarity.

The updated comment provides clear information about when the status is set to REFUNDED, which improves code readability and maintainability.


Line range hint 265-278: Summary: Refund validation checks successfully rearranged.

The changes in the refund function effectively address the PR objective of rearranging refund validation checks. By adding the status check as the first validation, the function now ensures that only transactions in the REQUESTED state can be refunded. This improves the overall security and logic of the refund process.

The updated comment also enhances code clarity by explicitly stating when the status is set to REFUNDED. These changes contribute to a more robust and maintainable codebase.

Copy link

cloudflare-workers-and-pages bot commented Sep 23, 2024

Deploying sanguine-fe with  Cloudflare Pages  Cloudflare Pages

Latest commit: 8388836
Status: ✅  Deploy successful!
Preview URL: https://78f2eec2.sanguine-fe.pages.dev
Branch Preview URL: https://feat-fbv2-refundcheckvalidat.sanguine-fe.pages.dev

View logs

Copy link

codecov bot commented Sep 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 38.42159%. Comparing base (e897b18) to head (8388836).
Report is 2 commits behind head on master.

Additional details and impacted files
@@                 Coverage Diff                 @@
##              master       #3172         +/-   ##
===================================================
+ Coverage   38.35432%   38.42159%   +0.06727%     
===================================================
  Files            424         424                 
  Lines          24464       24455          -9     
  Branches         148         148                 
===================================================
+ Hits            9383        9396         +13     
+ Misses         14335       14318         -17     
+ Partials         746         741          -5     
Flag Coverage Δ
packages 90.56974% <ø> (ø)
solidity 90.86758% <100.00000%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Collaborator

@ChiTimesChi ChiTimesChi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM - I fixed the tests that I managed to incorrectly define in #3127

Copy link

codecov bot commented Sep 26, 2024

Bundle Report

Changes will decrease total bundle size by 16.13kB (-0.05%) ⬇️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
explorer-ui-server-cjs* 865.78kB 283 bytes (-0.03%) ⬇️
explorer-ui-client-array-push* 2.31MB 750 bytes (-0.03%) ⬇️
synapse-interface-client-array-push* 7.25MB 23.72kB (-0.33%) ⬇️
widget-cjs-esm* 281.92kB 8.62kB (3.15%) ⬆️

ℹ️ *Bundle size includes cached data from a previous commit

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants