search

synapsecns / sanguine

Synapse Monorepo
MIT License
35 stars 27 forks source link

RFQ API: add bulk quotes endpoint #2846

Closed dwasse closed 2 weeks ago

dwasse commented 2 weeks ago

Summary by CodeRabbit

coderabbitai[bot] commented 2 weeks ago

Walkthrough

The changes introduce a new bulk quote upsertion feature in the RFQ system. An enhanced API now allows relayers to submit multiple quotes in a single request. Adopting this new functionality, the RFQ service has expanded its client, handler, and database interfaces, updated endpoint documentation, altered setup configurations, and introduced new request models.

Changes

Files Change Summary
services/rfq/api/client/client.go Added PutBulkQuotes method to AuthenticatedClient and clientImpl.
.../suite_test.go Moved variables and assignments from SetupSuite to SetupTest.
.../api_db.go Added UpsertQuotes to APIDBWriter.
.../store.go Added UpsertQuotes to Store struct.
.../request.go Added new struct PutBulkQuotesRequest.
.../handler.go Refactored ModifyQuote and added ModifyBulkQuotes function.
.../server.go Added new route and handling for /bulk_quotes.
.../docs/docs.go Documented new /bulk_quotes endpoint and model.
.../swagger.json, .../swagger.yaml Added /bulk_quotes endpoint and request model.
.../quoter.go Added bulk quotes submission and configuration flag SubmitSingleQuotes.
.../relconfig/config.go Added SubmitSingleQuotes to Config struct.
docs/bridge/docs/rfq/API/upsert-quotes.api.mdx Documented new bulk quotes upsertion API.

Sequence Diagram(s)

sequenceDiagram
    participant Relayer
    participant API
    participant Handler
    participant DB

    Relayer->>API: PUT /bulk_quotes
    API->>Handler: HandleBulkQuotes
    Handler->>DB: UpsertQuotes
    DB-->>Handler: Success/Error
    Handler-->>API: Status Response
    API-->>Relayer: HTTP Response

Poem

In the realm of quotes so vast,
Bulk submissions arrive at last,
A single stroke, multiple prints,
Setting prices without a hint.
Database now swiftly adapts,
Relayers smile, applause perhaps.
Bulk quotes, a job now simplified,
Efficiency has amplified.

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

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

Project coverage is 25.90211%. Comparing base (9916a14) to head (c2c7b6f).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #2846 +/- ## =================================================== - Coverage 25.91293% 25.90211% -0.01082% =================================================== Files 709 709 Lines 52441 52405 -36 Branches 80 80 =================================================== - Hits 13589 13574 -15 + Misses 37465 37445 -20 + Partials 1387 1386 -1 ``` | [Flag](https://app.codecov.io/gh/synapsecns/sanguine/pull/2846/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/2846/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `0.21082% <ø> (ø)` | | 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: c2c7b6f
Status: ✅  Deploy successful!
Preview URL: https://8b09a3a8.sanguine-fe.pages.dev
Branch Preview URL: https://feat-bulk-quote.sanguine-fe.pages.dev

View logs

codecov[bot] commented 2 weeks ago

Bundle Report

Changes will increase total bundle size by 13.18MB :arrow_up:

Bundle name Size Change
docs-bridge-client-array-push 7.88MB 7.88MB :arrow_up:
docs-bridge-server-cjs 14.75MB 14.75MB :arrow_up:
sdk-router-@synapsecns/sdk-router-esm (removed) 252.08kB :arrow_down:
sdk-router-@synapsecns/sdk-router-cjs (removed) 116.91kB :arrow_down:
synapse-interface-client-array-push (removed) 7.44MB :arrow_down:
synapse-interface-server-cjs (removed) 1.37MB :arrow_down:
synapse-interface-edge-server-array-push (removed) 83 bytes :arrow_down:
widget-esm-cjs (removed) 272.4kB :arrow_down: