fix(rest-api): Adds validSwap validation [SLT-321]

abtestingalpha commented 1 month ago

Description When a user requests an invalid swap through the api, the response is a 500 instead of a 400 with error message. This adds a validation to the swapRoute to check tha the from and to token are swappable.

Summary by CodeRabbit

New Features
- Introduced a validation step for swap operations to ensure supported token swaps.
- Added a new function to check if a swap between specified tokens is valid based on their swappability.
Bug Fixes
- Enhanced test coverage for invalid token swap scenarios, ensuring proper error handling.
Improvements
- Updated token information output to include swappability details, providing users with more comprehensive data.

coderabbitai[bot] commented 1 month ago

Walkthrough

The changes in this pull request enhance the swap route functionality within an Express application by introducing a new validation step for token swaps. A new function, validSwap, is added to validate the compatibility of token swaps based on the provided parameters. Additionally, the test suite for the swap route is updated to include tests for the newly introduced validation logic and the handling of the ETH token. The output of the tokenAddressToToken function is also modified to include a swappable property, providing more detailed token information.

Changes

File Path	Change Summary
`packages/rest-api/src/routes/swapRoute.ts`	Added import for `validSwap`. Included validation check using `validSwap` in the GET request handler.
`packages/rest-api/src/tests/swapRoute.test.ts`	Added `ETH` to bridgeable tokens imports. Introduced new test case for invalid token swap combinations.
`packages/rest-api/src/utils/tokenAddressToToken.ts`	Updated `tokenAddressToToken` to include `swappable` property in the returned object.
`packages/rest-api/src/validations/validSwap.ts`	Introduced `validSwap` function to validate token swaps based on `chain`, `fromToken`, and `toToken`.

Possibly related PRs

#3133: This PR modifies the swapTxInfoController to streamline token address handling, which is relevant to the validation logic introduced in the main PR for the swap route.
#3151: This PR introduces a new route that validates token parameters, which is related to the validation enhancements made in the main PR for the swap route.
#3180: The addition of the validateRouteExists function enhances the validation process for routes, which aligns with the new validation step added in the main PR for the swap route.
#3228: The updates to the bridgeable.ts file, including token address modifications, are relevant as they pertain to the validation of token parameters in the main PR.

Suggested labels

size/m

Suggested reviewers

trajan0x
bigboydiamonds

🐰 In the land of swaps, where tokens play,
A new check was added to brighten the day.
With validSwap in hand, the routes now gleam,
Ensuring each trade is more than a dream.
So hop along, friends, let’s celebrate right,
For swaps are now safer, and futures are bright! 🌟

📜 Recent review details

**Configuration used: .coderabbit.yaml** **Review profile: CHILL**

📥 Commits

Files that changed from the base of the PR and between 11824e814c9e4038bdca137452123e9e60dc58bf and a674a21831ca4a3ff7285fe48242c043019a1bbd.

📒 Files selected for processing (2)

* packages/rest-api/src/routes/swapRoute.ts (2 hunks) * packages/rest-api/src/tests/swapRoute.test.ts (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (2)

* packages/rest-api/src/routes/swapRoute.ts * packages/rest-api/src/tests/swapRoute.test.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://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 1 month ago

Deploying sanguine-fe with Cloudflare Pages

Latest commit:	`a674a21`
Status:	✅ Deploy successful!
Preview URL:	https://1232df0c.sanguine-fe.pages.dev
Branch Preview URL:	https://rest-api-valid-swap-path.sanguine-fe.pages.dev

View logs

codecov[bot] commented 1 month ago

Codecov Report

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

Project coverage is 90.43902%. Comparing base (4b49879) to head (a674a21). Report is 8 commits behind head on master.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## master #3247 +/- ## =================================================== - Coverage 91.00237% 90.43902% -0.56335% =================================================== Files 60 54 -6 Lines 1267 1025 -242 Branches 154 82 -72 =================================================== - Hits 1153 927 -226 + Misses 111 95 -16 Partials 3 3 ``` | [Flag](https://app.codecov.io/gh/synapsecns/sanguine/pull/3247/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/3247/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `90.43902% <ø> (ø)` | | | [solidity](https://app.codecov.io/gh/synapsecns/sanguine/pull/3247/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `?` | | 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.

synapsecns / sanguine