web3modal icon indicating copy to clipboard operation
web3modal copied to clipboard

Remove wallet guide component and related functionality (APKT-2883)

Open devin-ai-integration[bot] opened this issue 7 months ago • 8 comments

Remove wallet guide component and related functionality (APKT-2883)

Summary

This PR completely removes the "Haven't got a wallet?" button component (w3m-wallet-guide) and all related functionality from the AppKit codebase as specified in Linear ticket APKT-2883.

Changes Made

Component Removal

  • ✅ Deleted packages/scaffold-ui/src/partials/w3m-wallet-guide/index.ts
  • ✅ Deleted packages/scaffold-ui/src/partials/w3m-wallet-guide/styles.ts

Connect View Updates

  • ✅ Removed guideTemplate method from w3m-connect-view
  • ✅ Removed walletGuide property and related state
  • ✅ Removed wallet guide conditional rendering logic
  • ✅ Cleaned up imports and unused code

Router Updates

  • ✅ Removed 'Create' route that rendered with walletGuide="explore"

Configuration Removal

  • ✅ Removed enableWalletGuide property from OptionsController
  • ✅ Removed setEnableWalletGuide method
  • ✅ Removed enableWalletGuide initialization from appkit-base-client

Type Definitions

  • ✅ Removed WalletGuideType from TypeUtil files in:
    • packages/controllers/src/utils/TypeUtil.ts
    • packages/ui/src/utils/TypeUtil.ts
    • packages/ui-new/src/utils/TypeUtil.ts

Test Updates

  • ✅ Removed wallet guide test cases from w3m-connect-view.test.ts
  • ✅ Removed wallet guide methods from laboratory test files
  • ✅ Updated test mocks to remove wallet guide references

Social Login Widget

  • ✅ Removed wallet guide properties and logic
  • ✅ Simplified template methods to return null
  • ✅ Cleaned up unused imports and constants

Documentation

  • ✅ Added breaking change entry to CHANGELOG.md with migration guide

Issues Fixed

This removal addresses the following UI bugs:

  • The top section was empty when email/social was disabled and users clicked "Haven't got a wallet?"
  • The "or" separator was displayed twice when email/social was enabled and users clicked the button
  • Conflicts with the "UX by Reown" component

Breaking Changes

⚠️ BREAKING CHANGE: The enableWalletGuide configuration option has been completely removed.

Migration Guide

If you were using the enableWalletGuide option in your AppKit configuration, you can safely remove it:

// Before
createAppKit({
  // ... other options
  enableWalletGuide: false // Remove this line
})

// After  
createAppKit({
  // ... other options
  // enableWalletGuide option no longer exists
})

Testing

  • pnpm build passes successfully
  • pnpm run prettier:format passes successfully
  • ✅ All TypeScript compilation errors resolved
  • ✅ Removed wallet guide test cases updated appropriately

Linear Ticket

Fixes: APKT-2883

Link to Devin run

https://app.devin.ai/sessions/4724080d5beb4e629c88cde28f19655a

Requested by

[email protected]

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • [ ] Disable automatic comment and CI monitoring

🦋 Changeset detected

Latest commit: 554ac2703aa94caf66f1ac32a0a460b5970950d4

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 8 packages
Name Type
@reown/appkit Major
@reown/appkit-adapter-bitcoin Patch
@reown/appkit-adapter-ethers Patch
@reown/appkit-adapter-ethers5 Patch
@reown/appkit-adapter-solana Patch
@reown/appkit-adapter-wagmi Patch
@reown/appkit-cdn Patch
@reown/appkit-experimental Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

changeset-bot[bot] avatar Jun 03 '25 10:06 changeset-bot[bot]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
appkit-basic-html ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 10, 2025 11:09am
appkit-demo ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 10, 2025 11:09am
appkit-laboratory ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 10, 2025 11:09am
10 Skipped Deployments
Name Status Preview Comments Updated (UTC)
appkit-basic-example ⬜️ Ignored (Inspect) Jun 10, 2025 11:09am
appkit-basic-sign-client-example ⬜️ Ignored (Inspect) Jun 10, 2025 11:09am
appkit-basic-up-example ⬜️ Ignored (Inspect) Visit Preview Jun 10, 2025 11:09am
appkit-ethers5-bera ⬜️ Ignored (Inspect) Jun 10, 2025 11:09am
appkit-nansen-demo ⬜️ Ignored (Inspect) Jun 10, 2025 11:09am
appkit-vue-solana ⬜️ Ignored (Inspect) Jun 10, 2025 11:09am
appkit-wagmi-cdn-example ⬜️ Ignored (Inspect) Jun 10, 2025 11:09am
ethereum-provider-wagmi-example ⬜️ Ignored (Inspect) Jun 10, 2025 11:09am
next-wagmi-solana-bitcoin-example ⬜️ Ignored (Inspect) Jun 10, 2025 11:09am
vue-wagmi-example ⬜️ Ignored (Inspect) Jun 10, 2025 11:09am

vercel[bot] avatar Jun 03 '25 10:06 vercel[bot]

Warnings
:warning:

🔑 Potential High‑entropy string detected in apps/laboratory/tests/shared/validators/ModalValidator.ts (line 290): fd20dc426fb37566d803...

Generated by :no_entry_sign: dangerJS against 554ac2703aa94caf66f1ac32a0a460b5970950d4

github-actions[bot] avatar Jun 03 '25 10:06 github-actions[bot]

Coverage Report

Status Category Percentage Covered / Total
🔵 Lines 76.85% 28704 / 37350
🔵 Statements 76.85% 28704 / 37350
🔵 Functions 67.95% 2407 / 3542
🔵 Branches 84.22% 5859 / 6956
File Coverage
File Stmts Branches Functions Lines Uncovered Lines
Changed Files
packages/appkit/src/client/appkit-base-client.ts 74.4% 88.5% 75.84% 74.4% 176, 187-190, 203-229, 261-262, 264-265, 270-271, 355-356, 392-398, 461-462, 483-489, 492-493, 510-511, 579-583, 596-610, 635-641, 645-657, 660-662, 665-667, 670-672, 675-677, 680-686, 689-691, 694-700, 716-728, 734-767, 770-780, 832-833, 850-864, 870, 874-881, 894-898, 932-933, 988-992, 998-999, 1035-1040, 1111, 1115-1116, 1143-1144, 1157-1172, 1216-1217, 1230-1241, 1274-1282, 1327, 1333-1337, 1366-1369, 1389-1399, 1421-1432, 1461-1462, 1468-1494, 1672-1673, 1705-1706, 1709-1710, 1723-1726, 1729-1730, 1750-1751, 1754-1755, 1767-1768, 1781-1782, 1804, 1807, 1811, 1816-1835, 1838-1847, 1862-1863, 1906-1907, 1995-1996, 1999-2000, 2003-2006, 2009-2010, 2013-2014, 2017-2018, 2021-2022, 2025-2029, 2038-2047, 2056-2067, 515-523, 719, 839, 944-1177, 1336-1430, 1796
packages/controllers/src/controllers/OptionsController.ts 86.04% 97.95% 53.24% 86.04% 223, 247-248, 295, 299, 349-352, 356-359, 363-366, 370-373, 410, 336, 405
packages/scaffold-ui/src/modal/w3m-router/index.ts 61.62% 20.89% 87.5% 61.62% 36-46, 60, 69, 73, 77, 79, 84, 86, 88, 90, 92, 94, 96, 98, 100, 102, 104, 106, 108, 110, 112, 114, 116, 118, 120, 122, 124, 126, 128, 130, 132, 134, 138, 140, 142, 144, 146, 148, 150, 152, 154, 156, 158, 160, 162, 164, 166, 168, 170, 172, 174, 176, 178, 180, 190-191
packages/scaffold-ui/src/partials/w3m-social-login-widget/index.ts 63.63% 70% 55.55% 63.63% 46-47, 59-60, 69-70, 79, 84, 87, 92-93, 96-117, 127-133
packages/scaffold-ui/src/views/w3m-connect-view/index.ts 81.77% 85.71% 82.35% 81.77% 74, 77-78, 82, 102, 147, 152-157, 182, 196, 207, 245, 249, 280-281, 291, 305-306, 311-335, 345-346
packages/ui/src/utils/TypeUtil.ts 100% 100% 100% 100%
Generated in workflow #12530 for commit 554ac27 by the Vitest Coverage Report Action

github-actions[bot] avatar Jun 03 '25 10:06 github-actions[bot]

This needs a changeset

tomiir avatar Jun 10 '25 08:06 tomiir

Unit tests are failing. Also, rebuild the changeset

tomiir avatar Jun 10 '25 10:06 tomiir