Skip to content

Add Migration Guides for PnP Modal and No Modal SDKs (v9 to v10) #1104

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

Open
wants to merge 8 commits into
base: master
Choose a base branch
from

Conversation

ihsraham
Copy link
Collaborator

@ihsraham ihsraham commented May 13, 2025

Motivation and Context

This change adds complete migration documentation for upgrading Web3Auth PnP Modal and No Modal SDKs from v9 to v10.
It addresses the architectural changes introduced in v10, such as the removal of verifiers and adapters from frontend code, and the introduction of connectors, authConnectionId, and groupedAuthConnectionId.

It also simplifies frontend usage across React and non-React stacks and clarifies changes to private key providers, dashboard-based chain config, and wagmi-based blockchain calls.


Jira Link

DEVREL-1175


Description

  • Added two new MDX documentation files:

    • modal-v9-to-v10.mdx
    • no-modal-v9-to-v10.mdx
  • Both guides cover:

    • Breaking changes from v9 to v10
    • Changes in social login configuration (verifier to authConnectionId)
    • Adapter removal and use of connectors
    • Chain config and private key provider migration to dashboard
    • Updated usage for React (hooks) and non-React examples
    • Wagmi integration in no-modal and React
  • A side-by-side comparison table summarizes migration changes

  • No runtime code changes included


How has this been tested?

  • Rendered the MDX files locally in the Docusaurus environment
  • Verified markdown structure, code block formatting, and table alignment
  • Manually confirmed all contextual descriptions, especially for breaking changes
  • Cross-compared against v9 and v10 example apps to ensure accuracy

Screenshots (if appropriate)

N/A — content-only change


Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist:

  • My code follows the code style of this project. (run lint)
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.
  • My code requires a db migration.

TODOs

  • Ayush: Add Account Abstraction-related login updates to both guides where needed

  • Shahbaz: Add dashboard screenshots for grouped connection and chain config setup

  • Yash: Review and update Vue composables usage to match v10 hooks implementation

  • Yash: Finalize wagmi migration consistency across guides

  • Maharshi: Evaluate Wallet Services UI integration changes

    • If extensive: extract into a separate wallet-ui-migration-guide.mdx
    • If minimal: include directly in modal and no-modal guides as a section

Copy link

vercel bot commented May 13, 2025

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

Name Status Preview Comments Updated (UTC)
web3auth-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 15, 2025 2:04pm

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