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) Change bridge top bar on deposit address and remove awaiting BTC on more than 1 transfer #3987

Conversation

JoseRFelix
Copy link
Collaborator

No description provided.

Copy link

vercel bot commented Dec 2, 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 Dec 2, 2024 7:03pm
4 Skipped Deployments
Name Status Preview Comments Updated (UTC)
osmosis-frontend-datadog ⬜️ Ignored (Inspect) Dec 2, 2024 7:03pm
osmosis-frontend-dev ⬜️ Ignored (Inspect) Dec 2, 2024 7:03pm
osmosis-frontend-edgenet ⬜️ Ignored (Inspect) Dec 2, 2024 7:03pm
osmosis-testnet ⬜️ Ignored (Inspect) Dec 2, 2024 7:03pm

Copy link
Contributor

coderabbitai bot commented Dec 2, 2024

Walkthrough

The pull request introduces several changes across multiple files, primarily focusing on formatting consistency and component logic enhancements. In trade-page.ts, string literals were standardized to single quotes, and semicolons were removed for a streamlined style. The amount-screen.tsx file was updated to include a new hook for managing component unmounting and modified to handle conditional rendering based on feature flags. The nomic-pending-transfers.tsx file improved the conditional display of messages based on transaction states. Lastly, bridge.tsx enhanced the useBridgeStore functionality by adding a new state property for transaction types.

Changes

File Path Change Summary
packages/e2e/pages/trade-page.ts Converted double quotes to single quotes; removed semicolons for formatting consistency.
packages/web/components/bridge/amount-screen.tsx Added useUnmount hook; modified logic for displaying DepositAddressScreen based on conditions; enhanced error handling.
packages/web/components/nomic/nomic-pending-transfers.tsx Updated rendering logic to conditionally display awaiting BTC message based on the transactions array.
packages/web/hooks/bridge.tsx Added type property to useBridgeStore; updated ImmersiveBridge rendering logic based on type.

Possibly related PRs

Suggested reviewers

  • DavideSegullo

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/web/components/bridge/amount-screen.tsx

Oops! Something went wrong! :(

ESLint: 8.50.0

ESLint couldn't find the config "next/core-web-vitals" to extend from. Please check that the name of the config is correct.

The config "next/core-web-vitals" was referenced from the config file in "/packages/web/.eslintrc.json".

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

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 50a682e and e05e38a.

⛔ Files ignored due to path filters (17)
  • packages/web/localizations/de.json is excluded by !**/*.json
  • packages/web/localizations/en.json is excluded by !**/*.json
  • packages/web/localizations/es.json is excluded by !**/*.json
  • packages/web/localizations/fa.json is excluded by !**/*.json
  • packages/web/localizations/fr.json is excluded by !**/*.json
  • packages/web/localizations/gu.json is excluded by !**/*.json
  • packages/web/localizations/hi.json is excluded by !**/*.json
  • packages/web/localizations/ja.json is excluded by !**/*.json
  • packages/web/localizations/ko.json is excluded by !**/*.json
  • packages/web/localizations/pl.json is excluded by !**/*.json
  • packages/web/localizations/pt-br.json is excluded by !**/*.json
  • packages/web/localizations/ro.json is excluded by !**/*.json
  • packages/web/localizations/ru.json is excluded by !**/*.json
  • packages/web/localizations/tr.json is excluded by !**/*.json
  • packages/web/localizations/zh-cn.json is excluded by !**/*.json
  • packages/web/localizations/zh-hk.json is excluded by !**/*.json
  • packages/web/localizations/zh-tw.json is excluded by !**/*.json
📒 Files selected for processing (4)
  • packages/e2e/pages/trade-page.ts (1 hunks)
  • packages/web/components/bridge/amount-screen.tsx (5 hunks)
  • packages/web/components/nomic/nomic-pending-transfers.tsx (1 hunks)
  • packages/web/hooks/bridge.tsx (5 hunks)
✅ Files skipped from review due to trivial changes (1)
  • packages/e2e/pages/trade-page.ts
🔇 Additional comments (5)
packages/web/components/bridge/amount-screen.tsx (1)

612-615: Properly resetting type on component unmount

The use of useUnmount to reset the type in useBridgeStore to "quote" upon unmount is appropriate and ensures the store's state remains consistent when the component is unmounted.

packages/web/hooks/bridge.tsx (3)

39-39: Addition of type property to useBridgeStore

The introduction of the type state property with union types "quote" and "deposit-address" enhances the store's ability to manage different bridge modes effectively.


116-118: Implementation of setType method in useBridgeStore

The setType method is correctly implemented to update the type state within the store, providing a clear and maintainable way to manage the bridge type.


307-356: Conditional rendering of steps based on type

The logic to conditionally render the steps in the StepProgress component based on the type is well-designed. It ensures that the UI adapts correctly to the different bridge modes.

packages/web/components/nomic/nomic-pending-transfers.tsx (1)

168-172: Correct conditional rendering of awaiting BTC message

The updated logic correctly displays the awaiting BTC message only when there are no transactions, improving the user experience by preventing unnecessary messages when transactions are present.

Comment on lines +859 to +860
useBridgeStore.getState().setType("quote");

Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Avoid mutating state during render

Similar to the previous issue, calling useBridgeStore.getState().setType("quote") directly within the render function can introduce side effects during rendering.

Move this state mutation into a useEffect hook to align with React best practices:

- useBridgeStore.getState().setType("quote");

  /**
   * This will trigger an error boundary
   */
  if (!supportedSourceAssets && !isLoading) {
    throw new Error("Supported source assets are not defined");
  }

+ useEffect(() => {
+   useBridgeStore.getState().setType("quote");
+ }, []);

Committable suggestion skipped: line range outside the PR's diff.

@@ -802,6 +806,7 @@
toChain &&
toAsset
) {
useBridgeStore.getState().setType("deposit-address");
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Avoid mutating state during render

Calling useBridgeStore.getState().setType("deposit-address") directly within the render path can cause side effects during rendering, which violates React's principle that render functions should be pure and side-effect free. This can lead to unexpected behavior and difficult-to-trace bugs.

Consider moving this state mutation into a useEffect hook to ensure it runs after the component renders:

- useBridgeStore.getState().setType("deposit-address");
  return (
+   useEffect(() => {
+     useBridgeStore.getState().setType("deposit-address");
+   }, []);
+
    <DepositAddressScreen
      canonicalAsset={canonicalAsset}
      direction={direction}
      chainSelection={chainSelection}
      assetDropdown={assetDropdown}
      fromChain={fromChain}
      toChain={toChain}
      fromAsset={fromAsset}
      toAsset={toAsset}
      bridge={supportedBridgeInfo.depositAddressBridges[0]} // For now, only one bridge provider is supported
    />
  );

Committable suggestion skipped: line range outside the PR's diff.

@JoseRFelix JoseRFelix merged commit 799b18d into stage Dec 2, 2024
35 checks passed
@JoseRFelix JoseRFelix deleted the jose/fe-1266-change-bridging-top-bar-on-deposit-address-and-remove branch December 2, 2024 19:46
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.

3 participants