synapsecns / sanguine

Synapse Monorepo
MIT License
35 stars 25 forks source link

feat(listener): listener safe, finalized, latest block numbers #2762

Closed golangisfun123 closed 2 weeks ago

golangisfun123 commented 2 weeks 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 weeks ago

[!WARNING]

Rate limit exceeded

@golangisfun123 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 53 minutes and 45 seconds before requesting another review.

How to resolve this issue? After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.
How do rate limits work? CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://coderabbit.ai/docs/faq) for further information.
Commits Files that changed from the base of the PR and between 1ec0562b1e7da6596df7c463160b9c65119cfefd and 888792fb80aa71ecb8aa064ffc12ec928d5ae7d5.

Walkthrough

The updates to the ethergo package introduce enhanced block fetching with finality modes and block wait parameters in the chainListener struct. Changes include new options for configuring finality mode and block wait, restructured block number retrieval for better compatibility, and refactored test cases to validate the new functionalities.

Changes

File Change Summary
ethergo/listener/listener.go Added finalityMode and blockWait to chainListener, updated NewChainListener, replaced block fetch calls, and added getBlockNumber method.
ethergo/listener/listener_test.go Reordered imports, updated TestListenForEvents function, refactored NewChainListener calls, added event handling, and block comparisons.
ethergo/listener/options.go Introduced WithFinalityMode and WithBlockWait functions to set finality mode and block wait options in chainListener.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant ChainListener
    Client->>ChainListener: NewChainListener(opts...)
    ChainListener->>ChainListener: set finalityMode, blockWait
    Note right of ChainListener: Initialize chainListener with options
    Client->>ChainListener: Start listening for events
    ChainListener->>ChainListener: doPoll method
    ChainListener->>ChainListener: getBlockNumber()
    Note right of ChainListener: Retrieve block number considering finalityMode and blockWait

Poem

Changes blown by winds of code, In the chains where blocks erode, Options bloom, new paths are shown, Finality waits, our seeds are sown. With each poll, we fetch and see, The future of our blockchain be.


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.
codecov[bot] commented 2 weeks ago

Codecov Report

Attention: Patch coverage is 70.37037% with 8 lines in your changes missing coverage. Please review.

Project coverage is 26.20226%. Comparing base (3eccadb) to head (888792f). Report is 2 commits behind head on master.

Files Patch % Lines
ethergo/listener/listener.go 57.14286% 4 Missing and 2 partials :warning:
ethergo/listener/options.go 84.61538% 2 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #2762 +/- ## =================================================== + Coverage 25.94208% 26.20226% +0.26017% =================================================== Files 737 737 Lines 52729 52755 +26 Branches 80 80 =================================================== + Hits 13679 13823 +144 + Misses 37639 37522 -117 + Partials 1411 1410 -1 ``` | [Flag](https://app.codecov.io/gh/synapsecns/sanguine/pull/2762/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | Coverage Δ | | |---|---|---| | [agents](https://app.codecov.io/gh/synapsecns/sanguine/pull/2762/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `34.20858% <ø> (+0.03697%)` | :arrow_up: | | [cctp-relayer](https://app.codecov.io/gh/synapsecns/sanguine/pull/2762/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `31.93780% <ø> (ø)` | | | [ethergo](https://app.codecov.io/gh/synapsecns/sanguine/pull/2762/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `48.97669% <70.37037%> (+1.78696%)` | :arrow_up: | | [explorer](https://app.codecov.io/gh/synapsecns/sanguine/pull/2762/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `4.97877% <ø> (ø)` | | | [omnirpc](https://app.codecov.io/gh/synapsecns/sanguine/pull/2762/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `33.31747% <ø> (ø)` | | | [promexporter](https://app.codecov.io/gh/synapsecns/sanguine/pull/2762/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `9.86717% <ø> (ø)` | | | [rfq](https://app.codecov.io/gh/synapsecns/sanguine/pull/2762/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `26.69195% <ø> (ø)` | | | [scribe](https://app.codecov.io/gh/synapsecns/sanguine/pull/2762/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `18.17597% <ø> (+0.06437%)` | :arrow_up: | | [tools](https://app.codecov.io/gh/synapsecns/sanguine/pull/2762/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `30.55118% <ø> (ø)` | | 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.

cloudflare-pages[bot] commented 2 weeks ago

Deploying sanguine-fe with  Cloudflare Pages  Cloudflare Pages

Latest commit: 888792f
Status: ✅  Deploy successful!
Preview URL: https://654cf5d5.sanguine-fe.pages.dev
Branch Preview URL: https://feat-listener-finality.sanguine-fe.pages.dev

View logs