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

[Trade Tool]: Small QA Fixes #3803

Merged
merged 6 commits into from
Aug 28, 2024
Merged

[Trade Tool]: Small QA Fixes #3803

merged 6 commits into from
Aug 28, 2024

Conversation

crnbarr93
Copy link
Contributor

What is the purpose of the change:

These changes adjust the following for the buy/sell tab:

  • Non focused token amount restricted to 10 decimals (only when non-focused)
  • Sell tab fiat input now rounds up to avoid payment fiat value not matching fiat input amount for limit orders

Copy link

vercel bot commented Aug 28, 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 Aug 28, 2024 11:52am
4 Skipped Deployments
Name Status Preview Comments Updated (UTC)
osmosis-frontend-datadog ⬜️ Ignored (Inspect) Visit Preview Aug 28, 2024 11:52am
osmosis-frontend-dev ⬜️ Ignored (Inspect) Visit Preview Aug 28, 2024 11:52am
osmosis-frontend-edgenet ⬜️ Ignored (Inspect) Aug 28, 2024 11:52am
osmosis-testnet ⬜️ Ignored (Inspect) Visit Preview Aug 28, 2024 11:52am

@crnbarr93 crnbarr93 requested a review from a team August 28, 2024 09:13
Copy link
Contributor

coderabbitai bot commented Aug 28, 2024

Walkthrough

The changes introduce a new parameter, rounding, to the fixDecimalCount and transformAmount functions within the PlaceLimitTool component. This addition enables optional rounding behavior when formatting decimal values. The internal logic has been modified to utilize this new parameter, particularly in the setAmountSafe function, enhancing the handling of user inputs related to token amounts.

Changes

Files Change Summary
packages/web/components/place-limit-tool/... Updated fixDecimalCount and transformAmount functions to include a rounding parameter.
Adjusted internal logic in PlaceLimitTool to accommodate the new rounding parameter.
packages/web/e2e/tests/trade.wallet.spec.ts Replaced hardcoded string in cancelLimitOrder method calls with dynamic string interpolation for amount.

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between d199986 and e8d99b3.

Files selected for processing (2)
  • packages/web/components/place-limit-tool/index.tsx (8 hunks)
  • packages/web/e2e/tests/trade.wallet.spec.ts (2 hunks)
Files skipped from review as they are similar to previous changes (1)
  • packages/web/components/place-limit-tool/index.tsx
Additional comments not posted (2)
packages/web/e2e/tests/trade.wallet.spec.ts (2)

100-100: Dynamic String Interpolation in Test Case

The change to use dynamic string interpolation (Sell $${amount} of) enhances the flexibility of the test case by allowing different amounts to be inserted dynamically. This is a positive change as it aligns with the PR objectives to handle different scenarios more accurately.

The code change is approved as it correctly implements the required functionality.


125-125: Consistent Application of Dynamic String Interpolation

Similarly, the use of dynamic string interpolation in this test case (Sell $${amount} of) ensures consistency across test scenarios. This change allows the test to adapt to different amounts, enhancing the robustness of the test suite.

The code change is approved as it correctly implements the required functionality.


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 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 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
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: 2

Outside diff range, codebase verification and nitpick comments (2)
packages/web/components/place-limit-tool/index.tsx (2)

Line range hint 73-89: Enhance error handling in transformAmount.

The function transformAmount adjusts the input value based on its format and then limits the decimal places. However, it lacks error handling for non-numeric inputs which could lead to runtime errors when parseFloat is called in fixDecimalCount.

Consider adding validation for numeric inputs at the beginning of the function to ensure stability:

 const transformAmount = (
   value: string,
   decimalCount = 18,
   rounding = false
 ) => {
+  if (!/^\d*\.?\d*$/.test(value)) throw new Error('Invalid numeric input');
   let updatedValue = value;
   if (value.endsWith(".") && value.length === 1) {
     updatedValue = value + "0";
   }
   ...
 };

Line range hint 255-311: Review and adjust logic in setAmountSafe function.

This function is critical as it integrates the rounding and decimal precision adjustments into the main component logic. The changes made here are in line with the PR objectives, but there are a few considerations:

  • The use of undefined for maxDecimals in the call from line 376 might lead to unexpected behavior since the default value is 2. It should explicitly pass the correct decimal count based on the context.
  • The function is complex and handles multiple conditions; consider breaking it down into smaller, more manageable functions.

Refactor the function to improve readability and ensure consistent behavior by explicitly handling decimal counts and rounding:

 const setAmountSafe = (
   amountType: "fiat" | "token",
   value?: string,
   maxDecimals: number = 2,
   rounding: boolean = false
 ) => {
   ...
   const updatedValue = transformAmount(
     value,
     amountType === "fiat"
       ? maxDecimals
       : swapState.baseAsset?.coinDecimals,
     rounding
   ).trim();
+  if (amountType === "token" && typeof maxDecimals === 'undefined') {
+    maxDecimals = swapState.baseAsset?.coinDecimals || 18; // Assuming 18 as a safe default
+  }
   ...
 };

packages/web/components/place-limit-tool/index.tsx Outdated Show resolved Hide resolved
packages/web/components/place-limit-tool/index.tsx Outdated Show resolved Hide resolved
Copy link
Contributor

@yury-dubinin yury-dubinin left a comment

Choose a reason for hiding this comment

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

lgtm

@crnbarr93 crnbarr93 merged commit 2d87336 into stage Aug 28, 2024
32 checks passed
@crnbarr93 crnbarr93 deleted the connor/small-qa-changes branch August 28, 2024 12:34
@crnbarr93 crnbarr93 mentioned this pull request Sep 3, 2024
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