rearrange refund validation checks [SLT-185]

parodime commented 2 months ago

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.

coderabbitai[bot] commented 2 months ago

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

3138: The changes in the refund function in the main PR are directly related to the refund function introduced in PR #3138, as both involve the handling of refunds within the FastBridgeV2 contract.
3170: This PR enhances the FastBridgeV2 contract by storing detailed information about relay transactions, which may interact with the refund functionality by ensuring that only valid transactions can be refunded based on their relay status.
3189: This PR addresses solhint warnings in the FastBridgeV2 contract, including modifications that may indirectly affect the clarity and maintainability of the refund function's implementation.

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 5cac9e0be6dbf75f5cbc2c7d4e35d2a605ffd2f0 and 83888364a9a06ab8877dcd1594000cbbe4a451f0.

📒 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

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

cloudflare-workers-and-pages[bot] commented 2 months ago

Deploying sanguine-fe with 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

codecov[bot] commented 2 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

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

Additional details and impacted files

```diff @@ 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](https://app.codecov.io/gh/synapsecns/sanguine/pull/3172/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | Coverage Δ | | |---|---|---| | [packages](https://app.codecov.io/gh/synapsecns/sanguine/pull/3172/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `90.56974% <ø> (ø)` | | | [solidity](https://app.codecov.io/gh/synapsecns/sanguine/pull/3172/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `90.86758% <100.00000%> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov[bot] commented 2 months ago

Bundle Report

Changes will decrease total bundle size by 16.13kB (-0.05%) :arrow_down:. This is within the configured threshold :white_check_mark:

Detailed changes

| Bundle name | Size | Change | | ----------- | ---- | ------ | | explorer-ui-server-cjs* | 865.78kB | 283 bytes (-0.03%) :arrow_down: | | explorer-ui-client-array-push* | 2.31MB | 750 bytes (-0.03%) :arrow_down: | | synapse-interface-client-array-push* | 7.25MB | 23.72kB (-0.33%) :arrow_down: | | widget-cjs-esm* | 281.92kB | 8.62kB (3.15%) :arrow_up: |

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

synapsecns / sanguine