search

synapsecns / sanguine

Synapse Monorepo
MIT License
35 stars 25 forks source link

Rfq api/cli #2826

Closed golangisfun123 closed 3 days ago

golangisfun123 commented 5 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 5 days ago

[!IMPORTANT]

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Base branches to auto review (3) * feat/.* * master * fe-release

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

This update implements several enhancements across the ethergo and services/rfq packages. Key changes include updating constants, adding new methods to interfaces, expanding API capabilities to handle token withdrawals, modifying configurations and handlers to support these new functions, and introducing new command-line tools for these operations. Comprehensive tests ensure robustness and reliability.

Changes

File(s) Change Summary
ethergo/submitter/submitter.go Updated constant and added Address() method to TransactionSubmitter interface.
services/rfq/relayer/relapi/client.go Added Withdraw method to RelayerClient interface and implemented it.
services/rfq/relayer/relapi/handler.go Enhanced Handler struct, added Withdraw function, helper functions, new imports, and WithdrawRequest struct.
services/rfq/relayer/relapi/handler_test.go Added test for marshaling and unmarshaling WithdrawRequest struct.
services/rfq/relayer/relapi/server.go Modified RelayerAPIServer to include submitter and added a POST route for withdrawals.
services/rfq/relayer/relapi/server_test.go Added tests for Ethereum and ERC20 token withdrawals.
services/rfq/relayer/relapi/suite_test.go Expanded RelayerServerSuite with new imports, variables, and additional setup logic.
services/rfq/relayer/relconfig/config.go Added new fields to Config struct for withdrawal functionalities and helper function DecodeTokenID.
services/rfq/tools/withdrawal/cmd/cmd.go Introduced command-line tool for handling withdrawal processes.
services/rfq/tools/withdrawal/cmd/commands.go Defined configuration flags and command for running the withdrawal tool.
services/rfq/tools/withdrawal/withdraw/withdraw_test.go Added package declaration for testing withdrawal processes.
contrib/opbot/config/config.go Modified SignozBaseURL field and added comment for RelayerURLS in Config struct.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant RelayerAPI
    participant RelayerServer
    participant Submitter
    participant Blockchain

    Client->>RelayerAPI: POST /withdraw (withdrawRequest)
    RelayerAPI->>RelayerServer: Handle withdraw request
    RelayerServer->>Submitter: Submit transaction (submit)
    Submitter->>Blockchain: Send transaction
    Blockchain->>Submitter: Transaction receipt
    Submitter->>RelayerServer: Transaction success
    RelayerServer->>RelayerAPI: Return withdraw response
    RelayerAPI->>Client: WithdrawResponse (nonce)

Poem

In fields of code, where changes bloom,
We crafted features, lifted gloom.
Withdrawals flow with tokens bright,
API and CLI ignite.
Tests ensure the paths are clear,
For users far and engineers near.
Rejoice, for updates hold the key,
To seamless blockchain harmony! 🌿

[!TIP]

Early access features: enabled We are currently testing the following features in early access: - **OpenAI `gpt-4o` model for code reviews and chat**: OpenAI claims that this model is better at understanding and generating code than the previous models. We seek your feedback over the next few weeks before making it generally available. Note: - You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file. - Please join our [Discord Community](https://discord.com/invite/GsXnASn26c) to provide feedback and report issues. - OSS projects are currently opted into early access features by default.

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 5 days ago

Deploying sanguine-fe with  Cloudflare Pages  Cloudflare Pages

Latest commit: 97634de
Status: âœ…  Deploy successful!
Preview URL: https://6be918b5.sanguine-fe.pages.dev
Branch Preview URL: https://rfq-api-cli.sanguine-fe.pages.dev

View logs

codecov[bot] commented 5 days ago

Codecov Report

Attention: Patch coverage is 0% with 42 lines in your changes missing coverage. Please review.

Project coverage is 25.72228%. Comparing base (484a9a3) to head (c4b5ce5).

Files Patch % Lines
services/rfq/relayer/cmd/commands.go 0.00000% 36 Missing :warning:
services/rfq/relayer/relapi/handler.go 0.00000% 5 Missing :warning:
services/rfq/relayer/cmd/cmd.go 0.00000% 1 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## fix/rfq-api #2826 +/- ## ===================================================== + Coverage 25.60195% 25.72228% +0.12033% ===================================================== Files 765 708 -57 Lines 54863 52196 -2667 Branches 80 80 ===================================================== - Hits 14046 13426 -620 + Misses 39368 37390 -1978 + Partials 1449 1380 -69 ``` | [Flag](https://app.codecov.io/gh/synapsecns/sanguine/pull/2826/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | Coverage Δ | | |---|---|---| | [cctp-relayer](https://app.codecov.io/gh/synapsecns/sanguine/pull/2826/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `?` | | | [opbot](https://app.codecov.io/gh/synapsecns/sanguine/pull/2826/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `0.21067% <ø> (ø)` | | | [promexporter](https://app.codecov.io/gh/synapsecns/sanguine/pull/2826/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `?` | | | [rfq](https://app.codecov.io/gh/synapsecns/sanguine/pull/2826/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `27.64428% <0.00000%> (-0.17270%)` | :arrow_down: | 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.