Repository navigation
Embedded Wallets: combined SDK docs updates (iOS, Android, Web, Flutter, React Native) and rebrand - #3086
Open
yashovardhan wants to merge 19 commits into
Open
Embedded Wallets: combined SDK docs updates (iOS, Android, Web, Flutter, React Native) and rebrand#3086yashovardhan wants to merge 19 commits into
yashovardhan wants to merge 19 commits into
Conversation
Replace the "MetaMask Embedded Wallets" and "MetaMask Embedded Wallet(s) SDK" names with "Web3Auth by MetaMask, Embedded Wallet SDK" across the docs. - Use the full name on first mention in each page body, in page descriptions, and on standalone cards; use "Embedded Wallet SDK" in headings, titles, sidebar labels, and later mentions. - Name platform SDKs "Embedded Wallet SDK for <platform>". - Remove "(formerly/previously Web3Auth)" and "formerly Web3Auth Plug and Play" wording. - Normalize "Embedded Wallets SDK" to "Embedded Wallet SDK". - Update the Embedded Wallets product rule and terminology table. Package names, code identifiers, URLs, and the "Embedded Wallets" nav and dashboard labels are unchanged.
- Bump install instructions to web3auth-swift-sdk 13.0.0. - Rewrite the iOS migration guide to cover v6 through v12 to v13, with a new v13 section and a corrected v12 rename table. - Fix Swift snippets that didn't compile because labeled arguments were out of declaration order (Web3AuthOptions, Chains, AuthConnectionConfig, LoginParams). - Document all Web3AuthOptions parameters, the dashboard-driven sessionTime default, and chain precedence for Wallet Services. - Remove MFALevel.DEFAULT and unsupported ChainNamespace and ExtraLoginOptions values. - Correct enableMFA and manageMFA guidance for SFA users. - Add getIdentityToken, getAccessToken, refreshSession, and getUserInfoAsync docs. - Add tncLink, privacyPolicy, enableKeyExport, and autoApprove options. - Fix iOS quickstart step highlights, connect-blockchain snippets, and the examples list.
Verify JS, React, and Vue SDK pages, the web migration guide, feature, dashboard, troubleshooting, connect-blockchain, quickstart, and tutorial content against the v11.4.3 SDK source and the official examples. - Fix samples that would not compile (Wallet Services plugin usage, removed Solana types, getViewChain, wrong type imports) - Replace removed or renamed options and properties (storageType, eipStandard, connectedConnectorName, getUserInfo v9 fields, verifierIdField) - Correct hook/composable signatures and return fields; Vue refs - Fix Solana chain IDs (0x65-0x67) and XRPL provider setup - Correct migration guide breaking changes; add v11.1-v11.4 changes - Fix multi-wallet linking API usage - Add React and Vue pages for useChain, useWallets, useFunding, useReceive, useLinkAccount, useSwitchAccount, useX402Fetch, and Vue useSolanaClient - Fix Angular and Next.js quickstart builder steps
Align the Embedded Wallets Flutter documentation with web3auth_flutter 8.0.0 (Auth v11 / Wallet Services v6, Android native 11.0.0, iOS native 13.0.0). - Rewrite the Flutter migration guide for v8 (covers v3 through v7). - Document Swift Package Manager requirement for iOS. - Remove MFALevel.DEFAULT and fix the MFA settings example. - Make sessionTime optional (dashboard value by default). - Wrap initialize() in try/catch across samples. - Complete the Web3AuthOptions, WhiteLabelData, WalletServicesConfig, Chains, LoginParams, and Web3AuthResponse references. - Add usage pages for getAccessToken, getIdentityToken, refreshSession, and getWeb3AuthResponse; document getUserInfoAsync. - Update Flutter snippets in SocialLoginExamples and PasswordlessLoginExamples from the pre-v7 login API to connectTo. - Update the Flutter quickstart, tutorial, and Solana page.
Align the Android SDK docs with web3auth-android-sdk 11.0.1. - Bump the dependency to 11.0.1 and minSdk to 26. - Retarget the migration guide to v11 (MFALevel.DEFAULT removal, v11/v6 service URLs, initialize() session restore, sessionTime and WalletServicesConfig defaults, new session APIs). - Add usage pages for getAccessToken/getIdentityToken and refreshSession, and document getUserInfoAsync. - Fix initialize(), getPrivateKey(), and logout() session behavior. - Fix enableMFA/manageMFA guidance (no idToken; not available for SFA). - Fix custom authentication examples (required clientId and authConnectionId, EmailFlowType values, swapped grouped connection IDs, jwtParameters). - Document SFA limitations and run SFA connectTo off the main thread. - Update Web3AuthOptions, WhiteLabelData, and WalletServicesConfig fields. - Fix the Solana, Firebase, tutorial, and quickstart Android content.
- Rewrite the React Native SDK pages for @web3auth/react-native-sdk 10.0.0: useWeb3Auth().connection (ethereumProvider, solanaWallet) replaces provider/signer; connectTo resolves Connection | null. - Add hook pages for useAccessToken, useAuthTokenInfo, and useRefreshSession; mark useIdentityToken deprecated. - Add Ethereum hooks (Wagmi) and Solana hooks pages, including the polyfills and @web3auth/auth shim that Solana needs on 10.0.0. - Fix connectTo parameters, web3AuthOptions, MFA levels, whitelabel fields, and Solana chain IDs (0x65/0x66/0x67). - Require react-native-quick-crypto 1.x and document the Gradle 9 jcenter() workaround for @toruslabs/react-native-web-browser. - Rewrite the React Native migration guide to target v10 (from v3-v9). - Update EVM and Solana connect-blockchain pages, Metro troubleshooting, the quickstart builder, and Auth0/Firebase React Native snippets. - Remove unused v8 account abstraction partials.
- Restore ChainNamespace .solana and .other; note Wallet Services are EVM only. - Note that the dashboard confirmation modal setting overrides confirmationStrategy. - Document that v13.0.0 ignores flow_type and always uses the OTP email flow. - Describe the default session time as 30 days from the dashboard, and correct the older-version defaults in the migration table. - Note that SFA users get no session tokens or Ed25519 key. - Warn that logout deletes all of the app's generic password Keychain items. - Reword the v13 MFA migration note: SFA detection is new, connection reuse isn't. - Clarify chain selection, WhiteLabelData default overrides, getEd25519PrivateKey errors, Xcode 15 and Swift 5.9 requirements, and the CocoaPods version range. - Set the dashboard session duration default to 30 days.
Verified against web3auth-android-sdk 11.0.0 and web3auth-swift-sdk 13.0.0, the versions web3auth_flutter 8.0.0 pins. - enableMFA/manageMFA: remove idToken guidance; both throw for sessions created with idToken (ENABLE_MFA_NOT_ALLOWED / enabledMfaNotAllowed). - getEd25519PrivateKey throws without a session; use getPrivateKey as the session check on the Solana page and in the tutorial. - Dapp share examples use the OAuth custom-connection flow; idToken takes the SFA path, which ignores dappShare. - connectTo errors: Android maps all failures to UserCancelledException, iOS returns PlatformException (LoginFailedException). Drop UnKnownException and use PlatformException in showWalletUI/request/MFA samples. - SPM is on by default in recent Flutter (3.44); keep the flag as fallback and set the deployment target on the Runner target. - sessionTime: lead with the 30-day default. - Note iOS project-config failures surface from init, refreshSession failure clears the session, manageMFA requires MFA enabled, and the enableKeyExport dashboard fallback. - Restore the Flutter custom authentication link, fix tutorial wording, wrap initialize() in auth0/firebase samples, and note sample imports.
- Remove nonexistent MFA_LEVELS.DEFAULT from React and Vue MFA pages
- Vue useSignTransaction returns the base58 signature
- sessionTime falls back to the dashboard value, then 30 days
- Rewrite Solana Pay tutorial for v11 useSolanaWallet rpc and the
@solana/kit-based @solana/pay 1.x API, with SolanaProvider
- Add WalletOperationsError, WalletProviderError, and
AccountLinkingError codes
- Add groupedAuthConnectionId and account_abstraction to linked
account fields; clarify useWallets sync behavior
- getUserInfo returns { linkedAccounts: [] } for external wallets
- XRPL testnet chain ID 0x6 and wsTarget labels
- initialAuthenticationMode connect-only default was v10.10+
- Match the official examples: React Native 0.74 (bare) and Expo SDK 51, and the quickstart's minSdkVersion 23 / compileSdkVersion 34. - Document react-native-quick-crypto by version: 1.x (with react-native-nitro-modules and react-native-quick-base64 3.x+) for React Native 0.75+ with the New Architecture, 0.7.x otherwise. Label the 16 KB-page and randomBytes failures as observed on an emulator. - Migration guide: remove the useWeb3AuthUser row (v9 already returned isMFAEnabled and getUserInfo), describe the real connectTo change (WalletResult to Connection), and limit "doesn't throw" to the hook. - Scope smart account address order, user operations, and key export limits to ERC-4337; note EIP-7702 behavior. - Dapp share: kept until sign-out; a stored share overrides a dappShare passed to connectTo. - Quickstart: match the getWeb3AuthConfig(withAA) example and remove the unreachable wallet-aggregator step. - Add PASSKEYS and AUTHENTICATOR, walletSdkURL, AppOwnership.Guest; correct whitelabel mode default (light), dappUrl, defaultChainId fallback, provider recreation, useAuthTokenInfo token on idToken sessions, and the MFA highlight directive. - Session time defaults to the dashboard value (30 days by default). - Replace web3.js / ethers v5 wording on the React Native chain pages.
- Credit the service, not the client SDK, for issuing ID tokens, running on the Torus Network, MPC key management, and OTP email delivery. - Show the package name in quickstart install steps so the comma in the brand name doesn't read as an extra package. - Revert Smart Accounts Kit snapshots 1.5.0 through 1.7.0 to main. - Point the "as a signer" link in eoa-wallets.md at embedded-wallets.md. - Document when to keep "Embedded Wallets" (service, nav, dashboard, unmigrated titles) in the Embedded Wallets product rule. - Use the full name on first mention on pages that only had the short form, and fix a mixed-name sentence, "SDK for Web for", and two descriptions. - Rename example card titles from "Web3Auth PnP <platform> SDK", the SDK card headings, and the Embedded Wallets llms.txt link labels.
…a' into ew/combined-sdk-docs-update
…1aa1b' into ew/combined-sdk-docs-update
…t-9c679d' into ew/combined-sdk-docs-update
…9db9a' into ew/combined-sdk-docs-update
…2bafb' into ew/combined-sdk-docs-update Co-authored-by: Cursor <cursoragent@cursor.com> # Conflicts: # embedded-wallets/migration-guides/README.mdx
…branding-713f30' into ew/combined-sdk-docs-update Co-authored-by: Cursor <cursoragent@cursor.com> # Conflicts: # embedded-wallets/migration-guides/android.mdx # embedded-wallets/migration-guides/flutter.mdx # embedded-wallets/migration-guides/ios.mdx # embedded-wallets/migration-guides/react-native.mdx # embedded-wallets/sdk/ios/README.mdx # embedded-wallets/sdk/react-native/README.mdx # src/pages/quickstart/builder/embedded-wallets/react_native/stepContent/installationReactNative.mdx # src/pages/quickstart/builder/embedded-wallets/react_native/stepContent/rnQuickStart.mdx
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This was referenced Nov 10, 2026
yashovardhan
marked this pull request as ready for review
November 10, 2026 10:18
The snippet labeled 7 * 86400 as 30 days and gave a 1-day default. State 30 * 86400 seconds (30 days) for both.
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Combines six Embedded Wallets docs PRs into one branch for a single review pass. No content was added beyond what is in those PRs; the only edits made here are merge-conflict resolutions (listed below).
web3auth-swift-sdk13.0.0web3auth-android-sdk11.0.1 (see Known gaps)@web3auth/modal11.4.3web3auth_flutter8.0.0@web3auth/react-native-sdk10.0.0Each source PR is merged with a merge commit, in the order above, with the rebrand last so its naming applies on top of the SDK updates. See each source PR for the detailed change list and its review notes.
Conflict resolutions
All other files are exactly the content of their source PR, or a clean git auto-merge where several PRs touched different parts of a file.
embedded-wallets/migration-guides/README.mdx: kept each SDK PR's row (iOS v13, React Native v10, Flutter v8).migration-guides/{android,ios,flutter}.mdxAI prompt first line: SDK PR's target version (v11, v13, v8) with the rebrand's "Embedded Wallet SDK for " naming.migration-guides/react-native.mdx(3 hunks): Update Embedded Wallets React Native docs for SDK v10 #3084's v10 content, with the rebrand's naming in the skill/MCP sentence and the agent prompt's first line.sdk/ios/README.mdxintro: Update Embedded Wallets iOS SDK docs for v13 #3079's capability list with the rebrand's name, and without "(formerly Web3Auth Plug and Play)".sdk/react-native/README.mdxintro: Update Embedded Wallets React Native docs for SDK v10 #3084's v10 text with the rebrand's name.installationReactNative.mdx: Update Embedded Wallets React Native docs for SDK v10 #3084's text (React Native 0.74, quick-crypto 0.7.x) with the rebrand's name.rnQuickStart.mdx: Update Embedded Wallets React Native docs for SDK v10 #3084's Expo text.Scope outside
embedded-wallets/These changes all come from the source PRs and only touch Embedded Wallets content or naming:
src/.ew-sidebar.js.version-2.0.0snapshot), the MetaMask Connect Web3Auth quickstarts,static/llms.txt, and the llms plugin..cursor/rules/product-embedded-wallets.mdcand.cursor/rules/terminology.mdc(naming rules).Known gaps (not changed in this PR)
connectTowithidTokenopens the Auth flow by default (silent SFA requiresmfaLevel = MFALevel.NONE), andenableMFA/manageMFAno longer reject SFA oridTokenusers. The SFA, MFA, and session-token notes and the11.0.1dependency still need updating.migration-guides/README.mdxstill lists Android as v9 (v4 through v8).Verification
npm run buildsucceeds (onBrokenLinks: 'throw').Issue(s) fixed
Supersedes #3079, #3080, #3081, #3082, #3083, #3084.
Checklist