ChiTimesChi commented 2 months 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

Fixes #[Link to Issue]

Summary by CodeRabbit

New Features
- Introduced a new contract for gas benchmarking of the FastBridge V2 protocol.
- Added methods for testing bridge transactions.
Bug Fixes
- Improved transaction ID handling in claim functions for better clarity and redundancy reduction.
- Enhanced assertions to validate claim processes against expected conditions.

coderabbitai[bot] commented 2 months ago

Walkthrough

A new Solidity contract named FastBridgeV2GasBenchmarkSrcProtocolFeesTest has been introduced to facilitate gas benchmarking tests for the FastBridge V2 protocol. This contract includes two public view functions for testing bridge transactions. Additionally, modifications have been made to the FastBridgeV2GasBenchmarkSrcTest contract, particularly in transaction ID handling and assertions related to token and ETH claims, enhancing clarity and validation of the claim process.

Changes

File Path	Change Summary
packages/contracts-rfq/test/FastBridgeV2.GasBench.Encoding.t.sol	- Added `FastBridgeV2GasBenchmarkSrcProtocolFeesTest` contract. - Introduced `test_getBridgeTransaction` and `test_getBridgeTransactionV2` functions.
packages/contracts-rfq/test/FastBridgeV2.GasBench.Src.t.sol	- Updated `test_claim_token` and `test_claimWithAddress_token` to use local `txId` variable. - Modified assertions in `test_claim_eth` and `test_claimWithAddress_eth` to reference `txId`.

Possibly related PRs

#3138: The introduction of the FastBridgeV2 contract is directly related to the new gas benchmarking contract.
#3169: Changes to the prove function affect transaction validation, connected to the new testing functions.
#3170: Modifications to the relay function enhance transaction management, pertinent to the new tests.
#3172: Updates to the refund function ensure proper transaction status checks, relevant to the new benchmarks.
#3173: Restructuring of transaction status management relates to the new gas benchmarking tests.
#3189: Focus on reducing solhint warnings aligns with the improvements and testing in the main PR.
#3202: Introduction of relayer exclusivity is relevant to the new gas usage tests.
#3204: Changes to gas estimation tests provide accurate estimates for functionalities being tested.
#3207: Solhint warning fixes indicate ongoing improvements reflected in the new tests.

Suggested labels

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

Suggested reviewers

trajan0x

🐰 In the meadow, we hop and play,
New tests for gas, hip-hip-hooray!
With tokens and ETH, we claim with glee,
FastBridge V2, come dance with me!
As we benchmark and validate,
Our code shines bright, it’s truly great! 🌟

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.

github-actions[bot] commented 2 months ago

Changes to gas cost

Generated at commit: 38e54b8e7c1cce4f4bc74d95934109c2366a37f6, compared to commit: 12668b55c03135b501456689e2d07c9e07aab815

🧾 Summary (50% most significant diffs)

Contract	Method	Avg (+/-)	%

Full diff report 👇

| Contract | Deployment Cost (+/-) | Method | Min (+/-) | % | Avg (+/-) | % | Median (+/-) | % | Max (+/-) | % | # Calls (+/-) | |:-|-:|:-|-:|-:|-:|-:|-:|-:|-:|-:|-:| | **FastBridgeV2** | 2,700,676 (0) | _grantRole_ | 101,405 (0) | **0.00%** | 114,671 (-31) | **-0.03%** | 118,505 (0) | **0.00%** | 118,505 (0) | **0.00%** | 183 (+12) |

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

Deploying sanguine-fe with Cloudflare Pages

Latest commit:	`0145376`
Status:	✅ Deploy successful!
Preview URL:	https://87568a21.sanguine-fe.pages.dev
Branch Preview URL:	https://fix-fast-bridge-gas-bench-vi.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 28.14426%. Comparing base (ad48cb0) to head (0145376). Report is 2 commits behind head on master.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## master #3217 +/- ## =================================================== + Coverage 24.92918% 28.14426% +3.21508% =================================================== Files 198 184 -14 Lines 13061 12006 -1055 Branches 82 150 +68 =================================================== + Hits 3256 3379 +123 + Misses 9523 8346 -1177 + Partials 282 281 -1 ``` | [Flag](https://app.codecov.io/gh/synapsecns/sanguine/pull/3217/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/3217/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `90.56974% <ø> (ø)` | | | [promexporter](https://app.codecov.io/gh/synapsecns/sanguine/pull/3217/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `?` | | | [solidity](https://app.codecov.io/gh/synapsecns/sanguine/pull/3217/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `89.40678% <ø> (?)` | | 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.