search

synapsecns / sanguine

Synapse Monorepo
MIT License
41 stars 30 forks source link

[DNM] Bridge endpoint consolidation [SLT-453] #3371

Closed Defi-Moses closed 5 days ago

Defi-Moses commented 2 weeks ago

Summary by CodeRabbit

Release Notes

coderabbitai[bot] commented 2 weeks ago

Walkthrough

The pull request introduces enhancements to the Synapse Protocol REST API, specifically in the bridge and swap functionalities. It adds optional query parameters destAddress and address to their respective controllers and routes, updating the request handling and response structures accordingly. The API documentation is also revised to reflect these changes, including validation logic for the new parameters. Additionally, new test cases are added to ensure proper functionality and error handling for the updated routes.

Changes

File Path Change Summary
packages/rest-api/src/controllers/bridgeController.ts - Added optional destAddress parameter to the request query.
- Updated type definitions for request query.
- Modified response logic to include callData based on destAddress.
packages/rest-api/src/controllers/swapController.ts - Added optional address parameter to the request query.
- Updated logic to conditionally call Synapse.swap based on address presence, and modified response to include callData.
packages/rest-api/src/routes/bridgeRoute.ts - Added optional destAddress parameter in OpenAPI documentation and route validation.
- Updated response schema to include callData property.
packages/rest-api/src/routes/swapRoute.ts - Added optional address parameter in OpenAPI documentation.
- Implemented validation for address parameter.
- Updated response schema to include callData object.
packages/rest-api/src/tests/bridgeRoute.test.ts - Added new test cases for handling destAddress, including valid, invalid, and absence scenarios.
packages/rest-api/src/tests/swapRoute.test.ts - Added new test cases for handling address, including valid, invalid, and absence scenarios.
packages/rest-api/swagger.json - Updated API documentation to include new destAddress and address parameters for /bridge and /swap endpoints, respectively.

Possibly related PRs

Suggested labels

size/m, M-explorer-ui

Suggested reviewers

πŸ‡ In the land of code where the rabbits play,
New paths are forged, come join the fray!
With destAddress and address in tow,
Our API leaps, ready to grow!
So hop along, let’s test and see,
What wonders await in our code spree! 🌟

πŸ“œ Recent review details **Configuration used: .coderabbit.yaml** **Review profile: CHILL**
πŸ“₯ Commits Reviewing files that changed from the base of the PR and between 2782388e4d79010f5f3338b516bdbb439145408f and 7d0afc522c753d721fb581a0c1775af4850731b7.
πŸ“’ Files selected for processing (2) * `packages/rest-api/src/routes/bridgeRoute.ts` (3 hunks) * `packages/rest-api/src/routes/swapRoute.ts` (4 hunks)
🚧 Files skipped from review as they are similar to previous changes (2) * packages/rest-api/src/routes/bridgeRoute.ts * packages/rest-api/src/routes/swapRoute.ts

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://docs.coderabbit.ai) 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: 7d0afc5
Status: βœ…  Deploy successful!
Preview URL: https://23a8196e.sanguine-fe.pages.dev
Branch Preview URL: https://api-bridge-change.sanguine-fe.pages.dev

View logs

codecov[bot] commented 2 weeks ago

Codecov Report

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

Project coverage is 90.44834%. Comparing base (798286f) to head (7d0afc5). Report is 2 commits behind head on master.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #3371 +/- ## ============================================= Coverage 90.44834% 90.44834% ============================================= Files 54 54 Lines 1026 1026 Branches 82 82 ============================================= Hits 928 928 Misses 95 95 Partials 3 3 ``` | [Flag](https://app.codecov.io/gh/synapsecns/sanguine/pull/3371/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | Coverage Ξ” | | |---|---|---| | [packages](https://app.codecov.io/gh/synapsecns/sanguine/pull/3371/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `90.44834% <ΓΈ> (ΓΈ)` | | 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.