synapsecns / sanguine

Synapse Monorepo
MIT License
35 stars 25 forks source link

Submitter docs #2837

Open golangisfun123 opened 3 days ago

golangisfun123 commented 3 days 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 3 days 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 1 minutes and 1 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 dfbe06642951a466a42eb39bce1e2f47553074a9 and ea4ad48a404a76387a4723490d034058a245ac80.

Walkthrough

The recent updates enhance the Ethergo project's Submitter module, refining the SubmitTransaction method, clarifying reaper functionality, elaborating configuration options, and adding examples and observability metrics. The integration of Mermaid support into documentation tools and improved import organization also stands out.

Changes

Files Change Summaries
docs/bridge/docs/Services/Submitter.md Updated description, SubmitTransaction method details, reaper functionality, config details, examples, nonce management, and observability metrics.
ethergo/submitter/chain_queue.go Reordered import statements for better organization.
docs/bridge/docusaurus.config.ts Added support for Mermaid in markdown configuration and updated themes array with @docusaurus/theme-mermaid.
docs/bridge/package.json Added @docusaurus/theme-mermaid version 3.1.1 as a dependency.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Submitter as Submitter Module
    participant Database
    participant Prometheus

    User->>Submitter: SubmitTransaction(tx)
    Submitter->>Database: Store transaction
    Database->>Submitter: Return nonce
    Submitter->>User: Return nonce

    loop Reaper Functionality
        Submitter->>Database: Flush old entries
    end

    Submitter->>Prometheus: Report observability metrics

Poem

In the realm of Ether's glow,
The Submitter now does show,
Transactions clear and metrics bright,
Nonce and status in the night.
Configuration fine-tuned with care,
Mermaid flows now everywhere.
🌟✨


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.
cloudflare-pages[bot] commented 3 days ago

Deploying sanguine-fe with  Cloudflare Pages  Cloudflare Pages

Latest commit: ea4ad48
Status: ✅  Deploy successful!
Preview URL: https://f85df3ba.sanguine-fe.pages.dev
Branch Preview URL: https://submitter-docs.sanguine-fe.pages.dev

View logs

codecov[bot] commented 3 days ago

Codecov Report

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

Project coverage is 22.06607%. Comparing base (d0f1508) to head (ea4ad48). Report is 9 commits behind head on master.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #2837 +/- ## =================================================== - Coverage 25.91575% 22.06607% -3.84968% =================================================== Files 751 621 -130 Lines 53890 49524 -4366 Branches 80 0 -80 =================================================== - Hits 13966 10928 -3038 + Misses 38480 37294 -1186 + Partials 1444 1302 -142 ``` | [Flag](https://app.codecov.io/gh/synapsecns/sanguine/pull/2837/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/2837/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `34.09763% <ø> (ø)` | | | [cctp-relayer](https://app.codecov.io/gh/synapsecns/sanguine/pull/2837/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `31.93780% <ø> (ø)` | | | [core](https://app.codecov.io/gh/synapsecns/sanguine/pull/2837/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `?` | | | [ethergo](https://app.codecov.io/gh/synapsecns/sanguine/pull/2837/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `46.84660% <ø> (-1.42365%)` | :arrow_down: | | [explorer](https://app.codecov.io/gh/synapsecns/sanguine/pull/2837/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `4.97877% <ø> (ø)` | | | [git-changes-action](https://app.codecov.io/gh/synapsecns/sanguine/pull/2837/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `?` | | | [omnirpc](https://app.codecov.io/gh/synapsecns/sanguine/pull/2837/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `33.08129% <ø> (ø)` | | | [opbot](https://app.codecov.io/gh/synapsecns/sanguine/pull/2837/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `0.21082% <ø> (ø)` | | | [packages](https://app.codecov.io/gh/synapsecns/sanguine/pull/2837/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `?` | | | [promexporter](https://app.codecov.io/gh/synapsecns/sanguine/pull/2837/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `8.50242% <ø> (?)` | | | [rfq](https://app.codecov.io/gh/synapsecns/sanguine/pull/2837/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `28.01131% <ø> (+0.88968%)` | :arrow_up: | | [screener-api](https://app.codecov.io/gh/synapsecns/sanguine/pull/2837/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `?` | | | [scribe](https://app.codecov.io/gh/synapsecns/sanguine/pull/2837/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `18.17597% <ø> (ø)` | | | [tools](https://app.codecov.io/gh/synapsecns/sanguine/pull/2837/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.