synapsecns / sanguine

Synapse Monorepo
MIT License
42 stars 30 forks source link

activeQuote depositAmount [SLT-464] #3372

Closed parodime closed 2 weeks ago

parodime commented 2 weeks ago

ActiveQuoting needs to consider the deposit amount when preparing an Active RFQ response and utilize it to calculate a corresponding dest amount.

Summary by CodeRabbit

coderabbitai[bot] commented 2 weeks ago

Walkthrough

The changes in this pull request focus on enhancing the quoter.go file, specifically the generateActiveRFQ and generateQuotes methods within the Manager struct. A new field, OriginAmountExact, is added to the QuoteInput struct to accommodate exact deposit amounts during quote generation. The logic for handling these amounts is integrated into the quote generation process, including error handling improvements and adjustments to the getOriginAmount method to ensure quotes meet the specified deposit requirements. Additionally, several related files and test cases have been updated to reflect these changes.

Changes

File Path Change Summary
services/rfq/relayer/quoter/quoter.go - Added OriginAmountExact *big.Int field to QuoteInput struct.
- Enhanced generateActiveRFQ method to parse and include deposit amounts in quotes.
- Updated getOriginAmount method to check and adjust quote amounts based on deposit requirements.
- Modified generateQuotes method to initialize OriginAmountExact to nil in QuoteInput instances.
- Improved error handling during deposit parsing and quote generation.
services/rfq/relayer/quoter/quoter_test.go - Added TestGetOriginAmountActiveQuotes method to test GetOriginAmount functionality with various quote parameter scenarios.
services/rfq/api/db/api_db.go - Renamed OriginAmount field to OriginAmountExact in ActiveQuoteRequest struct.
- Updated FromUserRequest function to reflect the new field name.
services/rfq/api/model/request.go - Renamed OriginAmount field to OriginAmountExact in QuoteData struct.
services/rfq/api/model/response.go - Renamed OriginAmount field to OriginAmountExact in GetOpenQuoteRequestsResponse struct.
services/rfq/api/rest/handler.go - Updated dbActiveQuoteRequestToModel function to replace OriginAmount with OriginAmountExact.
services/rfq/api/rest/rfq.go - Updated methods to use OriginAmountExact instead of OriginAmount, affecting both active and passive RFQ handling.
services/rfq/api/rest/rfq_test.go - Updated test cases to replace OriginAmount with OriginAmountExact in PutRFQRequest data model.
services/rfq/api/rest/server_test.go - Updated TestGetOpenQuoteRequests function to replace OriginAmount with OriginAmountExact in test requests.
services/rfq/api/docs/docs.go - Updated API documentation to reflect the renaming of origin_amount to origin_amount_exact in relevant schemas.

Possibly related PRs

Suggested labels

size/l

Suggested reviewers

πŸ‡ In the meadow, where quotes do play,
A deposit's dance brightens the day.
With amounts now checked, and errors refined,
Our quoting's robust, perfectly aligned.
Hop, hop, hooray, for changes so bright,
In the world of RFQs, all feels just right! πŸ‡

[!WARNING] There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

πŸ”§ golangci-lint level=warning msg="[config_reader] The configuration option `run.skip-files` is deprecated, please use `issues.exclude-files`." level=warning msg="[config_reader] The configuration option `run.skip-dirs` is deprecated, please use `issues.exclude-dirs`." level=warning msg="[config_reader] The configuration option `run.skip-dirs-use-default` is deprecated, please use `issues.exclude-dirs-use-default`." level=warning msg="[lintersdb] The linter \"maligned\" is deprecated (step 2) and deactivated. It should be removed from the list of disabled linters. https://golangci-lint.run/product/roadmap/#linter-deprecation-cycle" level=warning msg="[lintersdb] The linter \"exhaustivestruct\" is deprecated (step 2) and deactivated. It should be removed from the list of disabled linters. https://golangci-lint.run/product/roadmap/#linter-deprecation-cycle" level=warning msg="[lintersdb] The linter \"ifshort\" is deprecated (step 2) and deactivated. It should be removed from the list of disabled linters. https://golangci-lint.run/product/roadmap/#linter-deprecation-cycle" level=warning msg="[lintersdb] The linter \"interfacer\" is deprecated (step 2) and deactivated. It should be removed from the list of disabled linters. https://golangci-lint.run/product/roadmap/#linter-deprecation-cycle" level=warning msg="[lintersdb] The linter \"nosnakecase\" is deprecated (step 2) and deactivated. It should be removed from the list of disabled linters. https://golangci-lint.run/product/roadmap/#linter-deprecation-cycle" level=warning msg="[lintersdb] The name \"goerr113\" is deprecated. The linter has been renamed to: err113." level=warning msg="The linter 'exportloopref' is deprecated (since v1.60.2) due to: Since Go1.22 (loopvar) this linter is no longer relevant. Replaced by copyloopvar." level=warning msg="The linter 'execinquery' is deprecated (since v1.58.0) due to: The repository of the linter has been archived by the owner. "

πŸ“œ Recent review details **Configuration used: .coderabbit.yaml** **Review profile: CHILL**
πŸ“₯ Commits Reviewing files that changed from the base of the PR and between 02e893beaf0f6974b08cd34889a0ea8a5c3dd6e2 and 1a323656875bd1d1f504ee941803266154c4016b.
πŸ“’ Files selected for processing (2) * `services/rfq/api/docs/docs.go` (2 hunks) * `services/rfq/api/model/request.go` (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1) * services/rfq/api/model/request.go
πŸ”‡ Additional comments (2)
services/rfq/api/docs/docs.go (2) `350-350`: **LGTM: Property rename in GetOpenQuoteRequestsResponse** The rename from `origin_amount` to `origin_amount_exact` aligns with the PR objective of incorporating exact deposit amounts into the ActiveQuoting system. Let's verify the consistency of this rename across the codebase: --- `514-514`: **LGTM: Property rename in QuoteData** The rename from `origin_amount` to `origin_amount_exact` in the QuoteData model maintains consistency with the ActiveQuoting enhancement. Let's verify the request/response handling for this property:
βœ… Verification successful **Property rename verified successfully.**
🏁 Scripts executed The following scripts were executed for the analysis: Script: ```shell #!/bin/bash # Description: Check for proper request/response handling of the renamed property # Search for QuoteData struct definition and usage ast-grep --pattern 'type QuoteData struct { $$$ origin_amount_exact $$$ $$$ }' # Check for any JSON marshaling/unmarshaling of this property rg -g '!*.go.swp' '(json\.Marshal|json\.Unmarshal).*QuoteData' ``` Length of output: 151 --- Script: ```shell #!/bin/bash # Description: Search for all usages of 'origin_amount_exact' in the codebase rg 'origin_amount_exact' ``` Length of output: 576 --- Script: ```shell #!/bin/bash # Description: Verify that 'origin_amount' is no longer used in the QuoteData struct ast-grep --pattern 'type QuoteData struct { $$$ origin_amount $$$ $$$ }' ``` Length of output: 80

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.
cloudflare-workers-and-pages[bot] commented 2 weeks ago

Deploying sanguine-fe with  Cloudflare Pages  Cloudflare Pages

Latest commit: 1a32365
Status: βœ…  Deploy successful!
Preview URL: https://11d4aec1.sanguine-fe.pages.dev
Branch Preview URL: https://feat-activequotedepositamoun.sanguine-fe.pages.dev

View logs

codecov[bot] commented 2 weeks ago

Codecov Report

Attention: Patch coverage is 64.70588% with 24 lines in your changes missing coverage. Please review.

Project coverage is 25.00380%. Comparing base (f2f1139) to head (1a32365). Report is 17 commits behind head on master.

Files with missing lines Patch % Lines
services/rfq/api/db/api_db.go 0.00000% 12 Missing :warning:
services/rfq/relayer/quoter/quoter.go 65.62500% 11 Missing :warning:
services/rfq/api/rest/rfq.go 93.75000% 1 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #3372 +/- ## ==================================================== - Coverage 43.84981% 25.00380% -18.84601% ==================================================== Files 74 199 +125 Lines 2317 13142 +10825 Branches 82 82 ==================================================== + Hits 1016 3286 +2270 - Misses 1295 9577 +8282 - Partials 6 279 +273 ``` | [Flag](https://app.codecov.io/gh/synapsecns/sanguine/pull/3372/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/3372/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `0.18337% <ΓΈ> (?)` | | | [promexporter](https://app.codecov.io/gh/synapsecns/sanguine/pull/3372/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `6.81642% <ΓΈ> (ΓΈ)` | | | [rfq](https://app.codecov.io/gh/synapsecns/sanguine/pull/3372/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `24.67080% <64.70588%> (?)` | | 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.