(1CT) Do not add the authenticator message if the 1CT swap tool CTA is hidden

[JoseRFelix]

What is the purpose of the change:

1CT add-authenticator message is added to every mobile transaction even though there is no option to enable this on mobile browsers.

Linear Task

https://linear.app/osmosis/issue/FE-1301/do-not-add-the-authenticator-message-if-the-1ct-swap-tool-is-hidden

Testing and Verifying

• 1CT CTA is displayed in desktop
• 1CT CTA is hidden on desktop and add authenticator message is not added automatically

[vercel]

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 18, 2024 5:54am

4 Skipped Deployments

Name	Status	Preview	Comments	Updated (UTC)
osmosis-frontend-datadog	⬜️ Ignored (Inspect)			Dec 18, 2024 5:54am
osmosis-frontend-dev	⬜️ Ignored (Inspect)			Dec 18, 2024 5:54am
osmosis-frontend-edgenet	⬜️ Ignored (Inspect)			Dec 18, 2024 5:54am
osmosis-testnet	⬜️ Ignored (Inspect)			Dec 18, 2024 5:54am

[coderabbitai]

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/hooks/one-click-trading/use-one-click-trading-swap-review.ts

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.

Walkthrough

The pull request modifies the useOneClickTradingSwapReview hook and its usage in the ReviewOrder component. The primary change involves renaming the isModalOpen parameter to enabled, which simplifies the control flow for one-click trading functionality. The modifications adjust how the hook manages state updates and conditions for transaction parameters, spend limit calculations, and modal interactions, focusing on a more streamlined approach to enabling one-click trading features.

Changes

File	Change Summary
packages/web/hooks/one-click-trading/use-one-click-trading-swap-review.ts	Renamed isModalOpen parameter to enabled, updating useEffect hooks and state management logic to check the new enabled state
packages/web/modals/review-order.tsx	Updated hook call to use enabled: isOpen && show1CT, added conditional rendering for OneClickTradingPanel, and optimized spend limit calculation logic

Sequence Diagram

sequenceDiagram
    participant User
    participant ReviewOrderModal
    participant OneClickTradingHook
    participant TransactionStore

    User->>ReviewOrderModal: Open Modal
    ReviewOrderModal->>OneClickTradingHook: Check enabled (isOpen && show1CT)
    alt One-Click Trading Enabled
        OneClickTradingHook->>TransactionStore: Update Transaction Parameters
        OneClickTradingHook->>TransactionStore: Calculate Spend Limit
    else One-Click Trading Disabled
        ReviewOrderModal->>ReviewOrderModal: Show Enable 1CT Panel
    end

Loading

Possibly Related PRs

• (Hotfix) Avoid computing overspend if 1CT session is disabled #3982: Enhances transaction parameter and spend limit handling in one-click trading
• Master -> Stage #3985: Modifies useOneClickRemainingSpendLimit with enabled state checks
• (Deposit/Withdraw) Fix withdrawals #3918: Updates useOneClickTradingSwapReview hook call in ReviewOrder
• (Portfolio) Open Tx details from recent activity #3942: Refines spend limit calculation logic in ReviewOrder

Suggested Reviewers

• jonator

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5105742 and ebb3be2.

📒 Files selected for processing (2)

• packages/web/hooks/one-click-trading/use-one-click-trading-swap-review.ts (2 hunks)
• packages/web/modals/review-order.tsx (1 hunks)

🧰 Additional context used

📓 Learnings (1)

packages/web/modals/review-order.tsx (1)

Learnt from: greg-nagy
PR: osmosis-labs/osmosis-frontend#3954
File: packages/web/modals/review-order.tsx:741-747
Timestamp: 2024-11-15T13:02:05.236Z
Learning: In `packages/web/modals/review-order.tsx`, when toggling one-click trading, if `transaction1CTParams` is undefined due to not retrieving default parameters from `api.local.oneClickTrading.getParameters`, we should keep `transaction1CTParams` undefined rather than providing a default state.

🔇 Additional comments (6)

packages/web/hooks/one-click-trading/use-one-click-trading-swap-review.ts (5)

43-45: LGTM! Parameter rename improves code semantics.

The rename from isModalOpen to enabled better represents the hook's activation state and aligns with the PR objective of controlling when 1CT features are active.

---

79-84: LGTM! Effect correctly manages transaction parameters state.

The effect properly updates transaction parameters only when the feature is enabled.

---

87-92: LGTM! Effect properly manages spend limit token decimals state.

The effect correctly updates spend limit token decimals only when the feature is enabled.

---

95-98: LGTM! Effect properly manages changes state.

The effect correctly updates changes only when the feature is enabled.

---

101-108: LGTM! Cleanup effect properly resets all states.

The effect correctly handles cleanup by resetting all states when the feature is disabled.

packages/web/modals/review-order.tsx (1)

134-134: LGTM! Hook usage correctly implements mobile-aware 1CT activation.

The condition isOpen && show1CT ensures that one-click trading is only enabled when both the modal is open and the feature should be shown, effectively preventing the authenticator message on mobile as intended.

---

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
• Mastodon
• Reddit
• LinkedIn

🪧 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 generate docstrings to generate docstrings for this PR. (Beta)
• @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.