synapsecns / sanguine

Synapse Monorepo
MIT License
43 stars 31 forks source link

fix dispute emit & revamp deposit xfer [SLT-295] [SLT-326] #3293

Closed parodime closed 1 month ago

parodime commented 1 month ago

gas optimized claim/refund transfers -- no longer using universalTransfer

dispute (& respective tests) switched to emitting relayer (as was always indicated by the output param label), not guard address.

storage-read optimizations to come in a follow-up PR

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

Walkthrough

The changes in this pull request focus on the FastBridgeV2 contract, enhancing the handling of bridge transactions, dispute resolution, refunds, and claims. Key modifications include updates to the dispute, refund, claim, bridge, and relay functions, with new logic for transferring tokens based on their type (ETH or ERC20) and improved error handling. Additionally, method signatures have been updated to reflect new parameters. The associated test contract has also been modified to rename a parameter for clarity.

Changes

File Change Summary
packages/contracts-rfq/contracts/FastBridgeV2.sol - Updated dispute function to capture disputedRelayer and modify emitted events.
- Altered refund logic to use conditional checks for ETH/ERC20 transfers, updating emitted events accordingly.
- Modified claim function for conditional token transfers and updated events.
- Refined bridge function to handle originFeeAmount correctly and adjusted event emissions.
- Clarified relay function logic for ETH/ERC20 transfers.
- Enhanced error handling throughout the contract.
- Method signatures updated for bridge, relay, claim, and prove functions.
packages/contracts-rfq/test/FastBridgeV2.Src.t.sol - Renamed guard parameter to relayer in expectBridgeProofDisputed function and updated all instances accordingly.
- Removed comments about previous parameter mislabeling for clarity.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant FastBridgeV2
    participant TokenContract

    User->>FastBridgeV2: initiateBridge(params)
    FastBridgeV2->>TokenContract: transferTokens()
    TokenContract-->>FastBridgeV2: confirmTransfer()
    FastBridgeV2->>User: emitBridgeEvent()

    User->>FastBridgeV2: disputeTransaction()
    FastBridgeV2->>FastBridgeV2: captureDisputedRelayer()
    FastBridgeV2->>User: emitDisputeEvent()

    User->>FastBridgeV2: requestRefund()
    FastBridgeV2->>TokenContract: conditionalTransfer()
    TokenContract-->>FastBridgeV2: confirmRefund()
    FastBridgeV2->>User: emitRefundEvent()

    User->>FastBridgeV2: claimCollateral()
    FastBridgeV2->>TokenContract: conditionalTransfer()
    TokenContract-->>FastBridgeV2: confirmClaim()
    FastBridgeV2->>User: emitClaimEvent()

Possibly related PRs

Suggested labels

size/m, M-deps, M-synapse-interface

Suggested reviewers

Poem

In the realm of bridges wide,
Tokens dance, with joy and pride.
Disputes resolved, and refunds flow,
With every claim, our spirits grow.
A relayer's role, now clear and bright,
In FastBridgeV2, all feels just right! πŸ‡βœ¨


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](http://discord.gg/coderabbit) 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 1 month ago

Deploying sanguine-fe with  Cloudflare Pages  Cloudflare Pages

Latest commit: 099a4f5
Status: βœ…  Deploy successful!
Preview URL: https://853d5e13.sanguine-fe.pages.dev
Branch Preview URL: https://ft-fixdisputeemit-revampdepo.sanguine-fe.pages.dev

View logs

codecov[bot] commented 1 month ago

Codecov Report

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

Project coverage is 91.52941%. Comparing base (99cf53e) to head (099a4f5). Report is 11 commits behind head on master.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #3293 +/- ## ==================================================== + Coverage 35.14833% 91.52941% +56.38108% ==================================================== Files 77 59 -18 Lines 2663 1275 -1388 Branches 82 160 +78 ==================================================== + Hits 936 1167 +231 + Misses 1722 104 -1618 + Partials 5 4 -1 ``` | [Flag](https://app.codecov.io/gh/synapsecns/sanguine/pull/3293/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | Coverage Ξ” | | |---|---|---| | [opbot](https://app.codecov.io/gh/synapsecns/sanguine/pull/3293/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/3293/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `90.44834% <ΓΈ> (ΓΈ)` | | | [solidity](https://app.codecov.io/gh/synapsecns/sanguine/pull/3293/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `95.98394% <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.

github-actions[bot] commented 1 month ago

Changes to gas cost

Generated at commit: 3bb8ae0a9a29b8a0ae5a8399ba42a31cacd8a7b2, compared to commit: fd75dbbbb6fec8ad2c35d5a16efb3a6a4812231a

🧾 Summary (50% most significant diffs)

Contract Method Avg (+/-) %
FastBridgeV2 claim(bytes)
claim(bytes,address)
dispute
refund
-76 βœ…
-76 βœ…
+150 ❌
-71 βœ…
-0.15%
-0.14%
+0.48%
-0.14%

Full diff report πŸ‘‡
| Contract | Deployment Cost (+/-) | Method | Min (+/-) | % | Avg (+/-) | % | Median (+/-) | % | Max (+/-) | % | # Calls (+/-) | |:-|-:|:-|-:|-:|-:|-:|-:|-:|-:|-:|-:| | **FastBridgeV2** | 3,022,643 (+30,283) | _bridge_
_claim(bytes)_
_claim(bytes,address)_
_dispute_
_refund_
_relay(bytes)_
_relay(bytes,address)_ | 70,606 (-80)
43,780 (-34)
46,633 (-34)
31,412 (+150)
47,657 (-28)
64,419 (0)
64,836 (0) | **-0.11%**
**-0.08%**
**-0.07%**
**+0.48%**
**-0.06%**
**0.00%**
**0.00%** | 82,028 (-47)
50,759 (-76)
52,362 (-76)
31,412 (+150)
51,682 (-71)
70,978 (+5)
71,395 (+5) | **-0.06%**
**-0.15%**
**-0.14%**
**+0.48%**
**-0.14%**
**+0.01%**
**+0.01%** | 82,666 (-75)
51,295 (-77)
52,898 (-77)
31,412 (+150)
51,843 (-70)
70,968 (+6)
71,385 (+6) | **-0.09%**
**-0.15%**
**-0.15%**
**+0.48%**
**-0.13%**
**+0.01%**
**+0.01%** | 94,751 (-69)
58,775 (-119)
59,128 (-119)
31,412 (+150)
56,029 (-113)
80,323 (+11)
80,740 (+11) | **-0.07%**
**-0.20%**
**-0.20%**
**+0.48%**
**-0.20%**
**+0.01%**
**+0.01%** | 260 (0)
6 (0)
6 (0)
6 (0)
12 (0)
6 (0)
6 (0) |