search

synapsecns / sanguine

Synapse Monorepo
MIT License
43 stars 31 forks source link

refactor(contracts-rfq): mark new methods as `V2` #3410

Closed ChiTimesChi closed 1 week ago

ChiTimesChi commented 1 week ago

Description A clear and concise description of the features you're adding in this pull request.

Additional context Add any other context about the problem you're solving.

Metadata

Summary by CodeRabbit

coderabbitai[bot] commented 1 week ago

Walkthrough

The pull request implements significant updates to the FastBridgeV2 contract and its associated interface, IFastBridgeV2. Key changes include renaming several functions to reflect a versioning update from V1 to V2, introducing new parameters and validation checks, and updating related tests to ensure compatibility with the new function signatures. The modifications enhance the bridge transaction process and integrate new functionalities, particularly concerning the handling of zap-related features.

Changes

File Path Change Summary
packages/contracts-rfq/contracts/FastBridgeV2.sol Functions renamed to include "V2": bridge → bridgeV2, refund → cancelV2, relay → relayV2, prove → proveV2, claim → claimV2, getBridgeTransaction → getBridgeTransactionV2. New structure BridgeParamsV2 introduced.
packages/contracts-rfq/contracts/interfaces/IFastBridgeV2.sol Functions renamed to include "V2": bridge, relay, prove, claim, cancel updated to their respective V2 versions. New structs BridgeParamsV2 and BridgeTransactionV2 added.
packages/contracts-rfq/test/FastBridgeV2.Dst.Base.t.sol Updated method call from fastBridge.relay to fastBridge.relayV2. No changes to parameters or structure.
packages/contracts-rfq/test/FastBridgeV2.Dst.t.sol Updated test cases to call relayV2 instead of relay. Maintained existing error handling and control flow.
packages/contracts-rfq/test/FastBridgeV2.Src.Base.t.sol Updated method calls to bridgeV2, proveV2, claimV2, and cancelV2. Structure and logic remain unchanged.
packages/contracts-rfq/test/FastBridgeV2.Src.t.sol Updated tests to use claimV2 and cancelV2. Enhanced error handling for unsupported versions and invalid requests.
packages/contracts-rfq/test/integration/FastBridgeV2.TokenZapV1.Src.t.sol Updated bridge function to call fastBridge.bridgeV2 with BridgeParamsV2. No changes to event expectations or balance checks.

Possibly related PRs

Suggested labels

size/m, needs-go-generate-services/rfq

Suggested reviewers

Poem

In the meadow where bridges gleam,
FastBridgeV2 is now the dream.
With functions renamed, oh what a sight,
Zapping through tokens, all feels right!
Parameters new, validations tight,
Hopping along, our code takes flight! 🐰✨

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://docs.coderabbit.ai) 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 week ago

Deploying sanguine-fe with  Cloudflare Pages  Cloudflare Pages

Latest commit: 209fbb1
Status: ✅  Deploy successful!
Preview URL: https://f6b6cda4.sanguine-fe.pages.dev
Branch Preview URL: https://refactor-fbv2-new-methods.sanguine-fe.pages.dev

View logs

github-actions[bot] commented 1 week ago

Changes to gas cost

Generated at commit: 68f39952b8bedf6a86b85c15d241ccf7de855d7c, compared to commit: b59c9d0a98cbe1982a28ff4d43c6cb97c7adddce

🧾 Summary (50% most significant diffs)

Contract Method Avg (+/-) %
FastBridgeV2 bridgeProofs
bridgeRelayDetails
canClaim
senderNonces		 -22 ✅
+66 ❌
-65 ✅
-22 ✅		 -3.64%
+10.65%
-2.15%
-2.02%
Full diff report 👇
| Contract | Deployment Cost (+/-) | Method | Min (+/-) | % | Avg (+/-) | % | Median (+/-) | % | Max (+/-) | % | # Calls (+/-) | |:-|-:|:-|-:|-:|-:|-:|-:|-:|-:|-:|-:| | **FastBridgeV2** | 4,309,763 (-888) | _GOVERNOR_ROLE_
_PROVER_ROLE_
_bridgeProofs_
_bridgeRelayDetails_
_canClaim_
_dispute_
_getBridgeTransaction_
_grantRole_
_nonce_
_protocolFees_
_senderNonces_
_setCancelDelay_
_setProtocolFeeRate_ | 284 (-22)
261 (-22)
582 (-22)
686 (+66)
2,960 (-65)
31,102 (+22)
4,009 (+22)
29,256 (-22)
262 (-45)
589 (-22)
569 (-22)
30,267 (-22)
47,336 (+22) | **-7.19%**
**-7.77%**
**-3.64%**
**+10.65%**
**-2.15%**
**+0.07%**
**+0.55%**
**-0.08%**
**-14.66%**
**-3.60%**
**-3.72%**
**-0.07%**
**+0.05%** | 284 (-22)
261 (-22)
582 (-22)
686 (+66)
2,960 (-65)
31,112 (+22)
4,009 (+22)
109,823 (-22)
262 (-45)
1,089 (-22)
1,069 (-22)
30,267 (-22)
47,336 (+22) | **-7.19%**
**-7.77%**
**-3.64%**
**+10.65%**
**-2.15%**
**+0.07%**
**+0.55%**
**-0.02%**
**-14.66%**
**-1.98%**
**-2.02%**
**-0.07%**
**+0.05%** | 284 (-22)
261 (-22)
582 (-22)
686 (+66)
2,960 (-65)
31,114 (+22)
4,009 (+22)
118,294 (-22)
262 (-45)
589 (-22)
569 (-22)
30,267 (-22)
47,336 (+22) | **-7.19%**
**-7.77%**
**-3.64%**
**+10.65%**
**-2.15%**
**+0.07%**
**+0.55%**
**-0.02%**
**-14.66%**
**-3.60%**
**-3.72%**
**-0.07%**
**+0.05%** | 284 (-22)
261 (-22)
582 (-22)
686 (+66)
2,960 (-65)
31,114 (+22)
4,009 (+22)
118,294 (-22)
262 (-45)
2,589 (-22)
2,569 (-22)
30,267 (-22)
47,336 (+22) | **-7.19%**
**-7.77%**
**-3.64%**
**+10.65%**
**-2.15%**
**+0.07%**
**+0.55%**
**-0.02%**
**-14.66%**
**-0.84%**
**-0.85%**
**-0.07%**
**+0.05%** | 88 (0)
134 (0)
12 (0)
12 (0)
12 (0)
6 (0)
1 (0)
356 (0)
4 (0)
536 (0)
248 (0)
67 (0)
21 (0) |
codecov[bot] commented 1 week ago

Codecov Report

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

Project coverage is 41.80602%. Comparing base (b59c9d0) to head (209fbb1). Report is 2 commits behind head on master.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #3410 +/- ## ============================================= Coverage 41.80602% 41.80602% ============================================= Files 87 87 Lines 2990 2990 Branches 82 82 ============================================= Hits 1250 1250 Misses 1737 1737 Partials 3 3 ``` | [Flag](https://app.codecov.io/gh/synapsecns/sanguine/pull/3410/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/3410/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/3410/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `98.76161% <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.

🚨 Try these New Features: