synapsecns / sanguine

Synapse Monorepo
MIT License
38 stars 29 forks source link

rfq: mimimal viable withdrawal api #2815

Closed trajan0x closed 3 months ago

trajan0x commented 3 months ago

Description

Add a withdrawal api to rfq

To do:

Future work:

Summary by CodeRabbit

coderabbitai[bot] commented 3 months ago

[!WARNING]

Rate limit exceeded

@trajan0x has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 16 minutes and 22 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 5ed6d9a306afa89a55e9768a3a1054e4b6147227 and 5c4554a47c71aac917075adc1a8501baed9dbc85.

Walkthrough

The updates focus on adding functionality for handling and testing token withdrawals within the RFQ relayer service. This includes updates to the handler logic, configuration enhancements, test additions, and command-line interface updates to support withdrawal operations. Specific changes include new helper functions, structs, and tests interacting with blockchain backends, as well as refined configurations for token ID handling and whitelisting.

Changes

File(s) Summary
services/rfq/relayer/relapi/handler.go Added fields and helper functions for token withdrawals, updated handler logic, and modified imports.
services/rfq/relayer/relapi/server_test.go Added Ethereum and ERC20 token withdrawal test functions, updated imports.
contrib/opbot/config/config.go Updated comments for SignozBaseURL and RelayerURLS fields.
ethergo/submitter/submitter.go Updated meterName constant, added Address() method to TransactionSubmitter interface.
services/rfq/relayer/cmd/cmd.go Included new withdrawCommand in CLI commands.
services/rfq/relayer/cmd/commands.go Added flags and logic for withdrawal commands, updated imports.
services/rfq/relayer/relapi/export_test.go Introduced TokenIDExists function for testing configuration token existence.
services/rfq/relayer/relapi/suite_test.go Added setup for withdrawal tests, mock token ID, and deployment management logic.
services/rfq/relayer/relconfig/config.go Added fields for API withdrawals and white listing, introduced DecodeTokenID function.
services/rfq/relayer/relconfig/config_test.go Added tests for DecodeTokenID function.

Sequence Diagram(s)

sequenceDiagram
  participant User
  participant CLI
  participant Handler
  participant Config
  participant Submitter
  participant Blockchain

  User->>CLI: Initiate withdrawal command
  CLI->>Handler: Process withdrawal command
  Handler->>Config: Validate token ID and address
  Config->>Handler: Return validation status
  Handler->>Submitter: Submit transaction
  Submitter->>Blockchain: Interact with blockchain for withdrawal
  Blockchain->>Submitter: Return transaction status
  Submitter->>Handler: Provide transaction result
  Handler->>User: Return withdrawal outcome

Poem

In code's vast land, where tokens roam, Withdrawals dance, away from home. From handler's care to tests that sing, A rabbit's joy in every string. With configs set and functions new, The blockchain whispers, "Thank you!"!


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 3 months ago

Codecov Report

Attention: Patch coverage is 52.63158% with 90 lines in your changes missing coverage. Please review.

Project coverage is 25.73801%. Comparing base (9cdc208) to head (5c4554a).

Files Patch % Lines
services/rfq/relayer/relapi/handler.go 63.20755% 30 Missing and 9 partials :warning:
services/rfq/relayer/cmd/commands.go 0.00000% 36 Missing :warning:
services/rfq/relayer/relapi/client.go 53.84615% 4 Missing and 2 partials :warning:
services/rfq/relayer/relconfig/config.go 71.42857% 4 Missing and 2 partials :warning:
ethergo/submitter/submitter.go 0.00000% 2 Missing :warning:
services/rfq/relayer/cmd/cmd.go 0.00000% 1 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #2815 +/- ## =================================================== + Coverage 25.64215% 25.73801% +0.09585% =================================================== Files 766 766 Lines 54972 55148 +176 Branches 80 80 =================================================== + Hits 14096 14194 +98 - Misses 39429 39494 +65 - Partials 1447 1460 +13 ``` | [Flag](https://app.codecov.io/gh/synapsecns/sanguine/pull/2815/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/2815/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `31.93780% <ø> (ø)` | | | [omnirpc](https://app.codecov.io/gh/synapsecns/sanguine/pull/2815/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/2815/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `0.21082% <ø> (ø)` | | | [promexporter](https://app.codecov.io/gh/synapsecns/sanguine/pull/2815/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/2815/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `28.04901% <53.19149%> (+1.01723%)` | :arrow_up: | | [tools](https://app.codecov.io/gh/synapsecns/sanguine/pull/2815/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-workers-and-pages[bot] commented 3 months ago

Deploying sanguine-fe with  Cloudflare Pages  Cloudflare Pages

Latest commit: 5c4554a
Status:⚡️  Build in progress...

View logs