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

(Deposit/Withdraw) Use denom to avoid excluding variants in deposits #3952

Open
wants to merge 1 commit into
base: stage
Choose a base branch
from

Conversation

JoseRFelix
Copy link
Collaborator

What is the purpose of the change:

Since WBTC will now use “allBtc” as its variant group key, we want to ensure it remains visible in the deposit list, even though it’s categorized as a variant. This is important because users may deposit WBTC from networks other than Bitcoin, such as Ethereum.

Linear Task

https://linear.app/osmosis/issue/FE-1225/use-denom-to-avoid-excluding-variants-in-deposits

Brief Changelog

  • Use denom to avoid excluding asset from deposit list

Testing and Verifying

  • Can see WBTC in deposit list after asset list update

Copy link

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

@JoseRFelix JoseRFelix changed the title (Deposit/Withdraw) Handle UI pending state when estimated time reaches 0 (Deposit/Withdraw) Use denom to avoid excluding variants in deposits Nov 15, 2024
@JoseRFelix JoseRFelix requested review from JeremyParish69 and a team November 15, 2024 05:05
Copy link
Contributor

coderabbitai bot commented Nov 15, 2024

Walkthrough

The changes in this pull request involve significant updates to the asset management procedures within the assetsRouter and the AssetSelectScreen component. Key modifications include the introduction of optional sorting parameters for asset retrieval, enhanced filtering logic, refined error handling, and updates to input schemas. The AssetSelectScreen component has been adjusted to utilize new asset symbol types directly, streamlining type definitions without altering core functionality. Overall, these changes aim to improve the robustness and flexibility of asset management operations.

Changes

File Path Change Summary
packages/trpc/src/assets.ts - Updated getUserBridgeAssets to include an optional sorting parameter.
- Enhanced getImmersiveBridgeAssets to filter by coinDenom instead of variantGroupKey.
- Refined error handling in getUserBridgeAsset.
- Improved input validation and error handling in getAssetHistoricalPrice and getCoingeckoAssetHistoricalPrice.
- Expanded sorting logic in getMarketAssets to include user-defined options.
- Updated input schemas for several procedures.
packages/web/components/bridge/asset-select-screen.tsx - Removed MainnetVariantGroupKeys and TestnetVariantGroupKeys imports; replaced with MainnetAssetSymbols and TestnetAssetSymbols.
- Updated variantsNotToBeExcluded, prioritizedDenoms, and deprioritizedDenoms constants to align with new asset symbols types.

Possibly related PRs

Suggested reviewers

  • jonator

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

packages/trpc/src/assets.ts

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the config "prettier" to extend from. Please check that the name of the config is correct.

The config "prettier" was referenced from the config file in "/packages/trpc/.eslintrc.js".

If you still have problems, please stop by https://eslint.org/chat/help to chat with the team.


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>, 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.

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

🧹 Outside diff range and nitpick comments (1)
packages/trpc/src/assets.ts (1)

635-635: Simplify the type assertion in includes check

The type assertion (typeof variantsNotToBeExcluded)[number] is unnecessary here. Since variantsNotToBeExcluded is an array of strings and asset.coinDenom is a string, you can simplify the code by removing the type assertion.

Apply this diff to simplify the code:

- !variantsNotToBeExcluded.includes(
-   asset.coinDenom as (typeof variantsNotToBeExcluded)[number]
- )
+ !variantsNotToBeExcluded.includes(asset.coinDenom)
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between dba7d07 and 240cf97.

📒 Files selected for processing (2)
  • packages/trpc/src/assets.ts (1 hunks)
  • packages/web/components/bridge/asset-select-screen.tsx (1 hunks)
🔇 Additional comments (3)
packages/web/components/bridge/asset-select-screen.tsx (3)

27-30: LGTM: Type-safe approach for asset symbol handling

The switch from variant group keys to specific asset symbols (MainnetAssetSymbols | TestnetAssetSymbols) provides better type safety and aligns with the PR's objective of denom-based filtering.


Line range hint 89-103: LGTM: Clean integration of asset filtering constants

The queryParameters memo correctly utilizes the updated constants for asset filtering and prioritization. The implementation maintains type safety while achieving the PR's objective of proper WBTC handling.


Line range hint 27-46: Verify WBTC visibility in the deposit list

The changes appropriately handle WBTC visibility by:

  1. Including it in variantsNotToBeExcluded to prevent filtering
  2. Adding it to prioritizedDenoms for better placement in the list

Let's verify that WBTC appears in the deposit list and that these changes don't affect other assets:

✅ Verification successful

Based on the search results, I can now provide a final response since we have sufficient information about how WBTC is handled in the codebase:

WBTC visibility changes are correctly implemented

The changes ensure proper WBTC visibility in the deposit list through a well-integrated approach:

  1. variantsNotToBeExcluded is used in the asset filtering logic (packages/trpc/src/assets.ts) to prevent WBTC from being excluded
  2. prioritizedDenoms array is used in sorting logic with explicit index comparison to ensure WBTC appears in the preferred order
  3. The implementation properly type-checks through TypeScript's satisfies operator
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify WBTC handling in the codebase
# Check for any other WBTC-specific handling that might conflict with these changes

# Search for WBTC-related configurations
rg -i "wbtc" --type ts --type tsx

# Check for any variant group related configurations that might affect WBTC
rg "variantGroup|coinDenom.*wbtc" --type ts --type tsx

Length of output: 146


Script:

#!/bin/bash
# Let's try with correct file type flags and broader search patterns

# Search for WBTC-related configurations
rg -t typescript -t tsx "wbtc|WBTC"

# Look for variant groups and asset configurations
rg -t typescript -t tsx "variantGroup|assetSymbols|MainnetAssetSymbols|TestnetAssetSymbols"

# Check how these constants are used
rg -t typescript -t tsx "variantsNotToBeExcluded|prioritizedDenoms|deprioritizedDenoms"

Length of output: 326


Script:

#!/bin/bash
# Let's try without file type flags and use path filtering instead

# Search for WBTC-related configurations
rg "wbtc|WBTC" --glob "*.{ts,tsx}"

# Look for variant groups and asset configurations
rg "variantGroup|assetSymbols|MainnetAssetSymbols|TestnetAssetSymbols" --glob "*.{ts,tsx}"

# Check how these constants are used
rg "variantsNotToBeExcluded|prioritizedDenoms|deprioritizedDenoms" --glob "*.{ts,tsx}"

Length of output: 144889

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.

1 participant