synapsecns / sanguine

Synapse Monorepo
MIT License
43 stars 31 forks source link

fix(rfq): use limit confirmations instead of finality #3153

Closed golangisfun123 closed 2 months ago

golangisfun123 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

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

Walkthrough

The changes involve modifying a method call in the limiter.go file and introducing a new method in the getters.go file. The GetFinalityConfirmations method is replaced with GetLimitConfirmations to adjust how confirmation limits are determined based on the transaction's origin chain ID. Additionally, the new method GetLimitConfirmations is added to the Config struct to enhance the retrieval of confirmation limits for different chain configurations.

Changes

Files Change Summary
services/rfq/relayer/limiter/limiter.go Renamed method call from GetFinalityConfirmations to GetLimitConfirmations in the hasEnoughConfirmations function.
services/rfq/relayer/relconfig/getters.go Added new method GetLimitConfirmations to Config struct, returning confirmation limits for specified chain IDs.

Suggested labels

go, size/xs

🐰 In the code where changes unfold,
A new limit for confirmations told.
From finality to limits, we hop,
Ensuring transactions don’t stop!
With methods new and old in play,
Our logic grows brighter each day! 🌟


Recent review details **Configuration used: .coderabbit.yaml** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between a03677e3ec3e0698281bf5978f0b6f1ef7ee0698 and ff443602d5c1c1461d60b2e4afb4f0c0a5ce67f9.
Files selected for processing (2) * services/rfq/relayer/limiter/limiter.go (1 hunks) * services/rfq/relayer/relconfig/getters.go (1 hunks)
Additional comments not posted (2)
services/rfq/relayer/limiter/limiter.go (1)
`101-101`: **Verify the implementation of the `GetLimitConfirmations` method.** The change from `GetFinalityConfirmations` to `GetLimitConfirmations` aligns with the PR objective of using limit confirmations instead of finality. The method call update looks good. To ensure the correctness of this change, please verify that the `GetLimitConfirmations` method is implemented correctly and returns the expected values for different chain IDs. You can use the following script to check the method implementation:
Verification successful --- **Implementation of `GetLimitConfirmations` method verified and correct** The `GetLimitConfirmations` method is properly implemented in `services/rfq/relayer/relconfig/getters.go` and correctly used in the `hasEnoughConfirmations` function. The method returns the limit confirmations for a given chain ID, aligning with the PR objective of using limit confirmations instead of finality.
Scripts executed The following scripts were executed for the analysis: Script: ```shell #!/bin/bash # Description: Verify the implementation of the `GetLimitConfirmations` method. # Test: Search for the method declaration. Expect: The method should exist in the codebase. ast-grep --lang go --pattern $'func (c *Config) GetLimitConfirmations(chainID int) (uint64, error) { $$$ }' # Test: Search for the method usage. Expect: The method should be used in the `hasEnoughConfirmations` function. rg --type go -A 5 $'GetLimitConfirmations' ``` Length of output: 1142
services/rfq/relayer/relconfig/getters.go (1)
`852-858`: **LGTM!** The `GetLimitConfirmations` function is implemented correctly and provides a useful utility for retrieving the limit of confirmations for a given chain ID. It properly handles the case when no chain configuration exists for the provided ID by returning an error.
--- 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  Cloudflare Pages

Latest commit: ff44360
Status: ✅  Deploy successful!
Preview URL: https://dd0fa15d.sanguine-fe.pages.dev
Branch Preview URL: https://use-limit-confirmations.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 36.37752%. Comparing base (d4d1c5a) to head (ff44360). Report is 22 commits behind head on master.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #3153 +/- ## ============================================= Coverage 36.37752% 36.37752% ============================================= Files 438 438 Lines 25535 25535 Branches 82 82 ============================================= Hits 9289 9289 Misses 15505 15505 Partials 741 741 ``` | [Flag](https://app.codecov.io/gh/synapsecns/sanguine/pull/3153/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/3153/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `0.48721% <ø> (ø)` | | | [promexporter](https://app.codecov.io/gh/synapsecns/sanguine/pull/3153/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `6.82171% <ø> (ø)` | | 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.

golangisfun123 commented 2 months ago

closed in favor of #3163