search

synapsecns / sanguine

Synapse Monorepo
MIT License
35 stars 25 forks source link

feat(synapse-interface): rfq transaction refund #2760

Open bigboydiamonds opened 2 weeks ago

bigboydiamonds commented 2 weeks ago

Summary by CodeRabbit

coderabbitai[bot] commented 2 weeks ago

Walkthrough

The changes to the synapse-interface package introduce a "refunded" status for transactions. Several components now handle this new status, impacting the user interface and transaction handling logic. Key updates include enhanced status checks in transaction components, new hooks to manage refund status, added properties to transaction interfaces, and new ABI files for smart contract interactions.

Changes

File Path Change Summary
.../_Transaction/_Transaction.tsx, .../_Transaction/components/Transactions.tsx, .../index.tsx Added routerAddress to components and their props. Added status handling for 'refunded'.
.../_Transaction/components/TransactionSupport.tsx Updated logic to handle 'refunded' status, removed isReverted declaration.
.../_Transaction/components/AnimatedProgressBar.tsx, .../TimeRemaining.tsx Added 'refunded' as a new status to these components.
.../_Transaction/helpers/getEstimatedTimeStatus.ts, .../_Transaction/helpers/calculateEstimatedTimeStatus.ts Added logic for isCheckTxForRefund when elapsedTime exceeds four hours in seconds.
.../_Transaction/helpers/useBridgeTxUpdater.ts Added refund transaction logic and new useEffect to handle isTxRefunded.
.../_Transaction/helpers/useTxRefundStatus.ts Introduced custom hook useTxRefundStatus to track refund status, including smart contract interaction.
.../constants/abis/fastBridge.json, .../constants/abis/fastBridgeRouter.json Added new ABI files defining functions, events, and errors related to fast bridge protocol and router contract.
.../_transactions/reducer.ts Added routerAddress and 'refunded' status to _TransactionDetails interface, introduced refundTransaction action.
.../transactions/actions.ts Added routerAddress property to PendingBridgeTransaction interface.
.../utils/hooks/use_TransactionsListener.ts Added routerAddress to the properties in use_TransactionsListener function.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant UI Component
    participant useTxRefundStatus
    participant Smart Contract

    User ->> UI Component : Initiates transaction check
    UI Component ->> useTxRefundStatus : Calls hook to check refund status
    useTxRefundStatus ->> Smart Contract : Queries refund status
    Smart Contract -->> useTxRefundStatus : Returns refund status
    useTxRefundStatus -->> UI Component : Updates refund status
    UI Component -->> User : Displays transaction status

Poem

πŸ‡ In code, a change quite grand,
Transactions now take a stand,
Refunded status, new and bright,
Propels our bridge to greater heights.
From four hours, checks now steer,
Refund logic makes it clear!
πŸŒ‰πŸ’»πŸŽ‰

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 .` - `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 Configration 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](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-pages[bot] commented 2 weeks ago

Deploying sanguine-fe with  Cloudflare Pages  Cloudflare Pages

Latest commit: d7c6388
Status: βœ…  Deploy successful!
Preview URL: https://4d4100f6.sanguine-fe.pages.dev
Branch Preview URL: https://fe-refund-transaction.sanguine-fe.pages.dev

View logs

cloudflare-pages[bot] commented 2 weeks ago

Deploying sanguine with  Cloudflare Pages  Cloudflare Pages

Latest commit: d7c6388
Status: βœ…  Deploy successful!
Preview URL: https://99fa08b1.sanguine.pages.dev
Branch Preview URL: https://fe-refund-transaction.sanguine.pages.dev

View logs

codecov[bot] commented 2 weeks ago

Codecov Report

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

Project coverage is 26.26025%. Comparing base (d0f1508) to head (d7c6388).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #2760 +/- ## =================================================== + Coverage 25.91575% 26.26025% +0.34450% =================================================== Files 751 677 -74 Lines 53890 49375 -4515 Branches 80 80 =================================================== - Hits 13966 12966 -1000 + Misses 38480 35091 -3389 + Partials 1444 1318 -126 ``` | [Flag](https://app.codecov.io/gh/synapsecns/sanguine/pull/2760/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | Coverage Ξ” | | |---|---|---| | [cctp-relayer](https://app.codecov.io/gh/synapsecns/sanguine/pull/2760/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `?` | | | [opbot](https://app.codecov.io/gh/synapsecns/sanguine/pull/2760/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `?` | | | [packages](https://app.codecov.io/gh/synapsecns/sanguine/pull/2760/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `90.47619% <ΓΈ> (ΓΈ)` | | 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.