osmosis-labs / osmosis-frontend

Web interface for Osmosis Zone
https://app.osmosis.zone/
Apache License 2.0
230 stars 416 forks source link

fix: BOOT token invalid swaps #3822

Closed crnbarr93 closed 1 month ago

crnbarr93 commented 1 month ago

What is the purpose of the change:

These changes fix an issue when a coin with 0 decimal places is used for a quote.

Linear Task

FE-1073

Brief Changelog

vercel[bot] commented 1 month ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
osmosis-frontend ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 3, 2024 5:55pm
4 Skipped Deployments | Name | Status | Preview | Comments | Updated (UTC) | | :--- | :----- | :------ | :------- | :------ | | **osmosis-frontend-datadog** | ⬜️ Ignored ([Inspect](https://vercel.com/osmo-labs/osmosis-frontend-datadog/BLJ2PJCLMupXtd9TUZyfoHNQ7uNu)) | | | Sep 3, 2024 5:55pm | | **osmosis-frontend-dev** | ⬜️ Ignored ([Inspect](https://vercel.com/osmo-labs/osmosis-frontend-dev/EFbNSbv4eCg3EuApmS4aqNF8dRZK)) | | | Sep 3, 2024 5:55pm | | **osmosis-frontend-edgenet** | ⬜️ Ignored ([Inspect](https://vercel.com/osmo-labs/osmosis-frontend-edgenet/A1a4Ryw3Pd5rvWUgU9M7ydJveVQe)) | | | Sep 3, 2024 5:55pm | | **osmosis-testnet** | ⬜️ Ignored ([Inspect](https://vercel.com/osmo-labs/osmosis-testnet/3iTU84Nx8otgH724qf6cyNkpPX88)) | | | Sep 3, 2024 5:55pm |
coderabbitai[bot] commented 1 month ago

Walkthrough

The changes enhance the useQueryRouterBestQuote function in the packages/web/hooks/use-swap.tsx file by adding a condition to check for zero amounts in quotes and modifying checks for token decimal values. These alterations ensure early returns for invalid quotes and clarify the intent of decimal checks, improving the overall handling of quote data.

Changes

Files Change Summary
packages/web/hooks/use-swap.tsx Enhanced useQueryRouterBestQuote by adding zero amount check for quotes and refining checks for token decimals to ensure valid data processing. Updated parameters for getSwapMessages with non-null assertions.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Hook
    participant QuoteService

    User->>Hook: Request quote
    Hook->>QuoteService: Fetch quote
    QuoteService-->>Hook: Return quote
    Hook->>Hook: Check if quote.amount is zero
    alt Valid quote
        Hook->>Hook: Check token decimal values
        Hook->>User: Return valid quote
    else Invalid quote
        Hook->>User: Return error
    end

[!TIP] We have updated our review workflow to use the Anthropic's Claude family of models. Please share any feedback in the discussion post on our Discord.


Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between 0e2b361950ba8ebb29e25e1bbae1e6171b5abfa2 and c4e0bfe8e5e19e136b8f4a1c2ee557a1da8850eb.
Files selected for processing (1) * packages/web/hooks/use-swap.tsx (3 hunks)
Additional comments not posted (2)
packages/web/hooks/use-swap.tsx (2)
`1572-1575`: **Ensure all required parameters are defined before calling `getSwapMessages`.** The code correctly checks that all required parameters are defined before calling `getSwapMessages`. This prevents potential errors due to undefined values. --- `1581-1582`: **Use non-null assertions only when values are guaranteed to be defined.** The non-null assertions (`!`) are used correctly here since the code checks that `tokenInCoinDecimals` and `tokenOutCoinDecimals` are not undefined before calling `getSwapMessages`.
--- 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 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. ### CodeRabbit Configuration 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.