Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: BOOT token invalid swaps #3822

Merged
merged 2 commits into from
Sep 3, 2024
Merged

fix: BOOT token invalid swaps #3822

merged 2 commits into from
Sep 3, 2024

Conversation

crnbarr93
Copy link
Contributor

@crnbarr93 crnbarr93 commented Sep 3, 2024

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

  • Altered tokenInCoinDecimals/tokenOutCoinDecimals check to check type rather than existence

@crnbarr93 crnbarr93 requested a review from a team September 3, 2024 17:50
Copy link

vercel bot commented Sep 3, 2024

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) Sep 3, 2024 5:55pm
osmosis-frontend-dev ⬜️ Ignored (Inspect) Sep 3, 2024 5:55pm
osmosis-frontend-edgenet ⬜️ Ignored (Inspect) Sep 3, 2024 5:55pm
osmosis-testnet ⬜️ Ignored (Inspect) Sep 3, 2024 5:55pm

Copy link
Contributor

coderabbitai bot commented Sep 3, 2024

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
Loading

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 0e2b361 and c4e0bfe.

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
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • 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 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Collaborator

@MaxMillington MaxMillington left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm thanks!

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (1)
packages/web/hooks/use-swap.tsx (1)

1545-1551: LGTM! Consider extracting the quote amount check to a separate function.

The code changes are approved. However, consider extracting the quote amount check to a separate function for better readability and maintainability.

Apply this diff to extract the quote amount check:

 const acceptedQuote = useMemo(() => {
+  const isQuoteAmountValid = (quote: typeof outGivenInQuote.data | typeof inGivenOutQuote.data) =>
+    quote && quote.amount.toDec().isPositive();
+
   if (
-    !quote ||
+    !isQuoteAmountValid(quote) ||  
     !input.tokenIn ||
     !input.tokenOut ||
-    quote.amount.toDec().isZero()
   )
     return;
   
   // ...
 }, [quote, quoteType, input.tokenInAmount, input.tokenIn, input.tokenOut]);

@crnbarr93 crnbarr93 mentioned this pull request Sep 3, 2024
@crnbarr93 crnbarr93 merged commit 1356272 into stage Sep 3, 2024
33 checks passed
@crnbarr93 crnbarr93 deleted the connor/boot-fix branch September 3, 2024 18:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants