Repository navigation
Update Flutter SDK docs for web3auth_flutter v8 - #3083
Closed
yashovardhan wants to merge 2 commits into
Closed
yashovardhan wants to merge 2 commits into
yashovardhan wants to merge 2 commits into
Conversation
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.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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.
This was referenced Nov 9, 2026
Member
Author
|
Superseded by #3086, which combines this branch with the other Embedded Wallets SDK docs updates and the rebrand into one PR for review. No further changes should land here. |
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
Updates the Embedded Wallets Flutter documentation to match
web3auth_flutter8.0.0 (Auth v11 / Wallet Services v6, Android native11.0.0, iOS native Web3Auth13.0.0via Swift Package Manager). Verified against the SDK source onWeb3Auth/web3auth-flutter-sdkmaster andWeb3Auth/web3auth-flutter-examplesmain.Migration guide
migration-guides/flutteras a v8 guide covering v3 through v7: AI prompt, install steps, v8 breaking changes, new APIs table, and a v8 column in the summary table.Flutter SDK reference
^8.0.0; documented the iOS Swift Package Manager requirement (the plugin podspec no longer declares a CocoaPodsWeb3Authdependency) and Xcode 15+.MFALevel.DEFAULT(removed in v8) and fixed the MFA settings example, which didn't compile.sessionTimeis optional and defaults to the dashboard value.initialize()intry/catchin all samples (it throws when no session is active).Web3AuthOptions,WhiteLabelData(tncLink,privacyPolicy),WalletServicesConfig(enableKeyExport),Chains,LoginParams(recordId,loginSource), andWeb3AuthResponsereferences.getAccessToken,getIdentityToken,refreshSession,getWeb3AuthResponse; documentedgetUserInfoAsync. Sidebar updated.Elsewhere
SocialLoginExamplesandPasswordlessLoginExamplesrendered the pre-v7 Flutter API (Web3AuthFlutter.login/Provider.x) on every social and passwordless auth page; nowconnectTowithAuthConnection.initialize()call.Verified against the native SDKs
All behavior below was checked against
web3auth-android-sdk11.0.0 andweb3auth-swift-sdk13.0.0, the versions 8.0.0 pins.enableMFA/manageMFAthrow for sessions created withidToken(ENABLE_MFA_NOT_ALLOWED/enabledMfaNotAllowed), so the docs no longer suggest passingidToken.getEd25519PrivateKeythrows without a session; onlygetPrivateKeyreturns"", so it is the documented session check.idTokentakes the SFA path, which ignoresdappShare.connectTofailure isUserCancelledException; on iOS it is aPlatformException(LoginFailedException).chainsentry to the native SDK; iOS passes all.flutter configflag is documented as a fallback.sessionTimedefaults to 30 days (or the dashboard value when set);enableKeyExportfalls back to the dashboard setting (defaultfalse).Known SDK-side issues (not docs)
getEd25519PrivateKeyreturns an empty string when signed out; it throws.enableMFA()/manageMFA()take no arguments and still instructspod install.Issue(s) fixed
N/A
Preview
Key pages:
/embedded-wallets/migration-guides/flutter//embedded-wallets/sdk/flutter//embedded-wallets/sdk/flutter/advanced//embedded-wallets/sdk/flutter/usage/Local
npm run buildsucceeds with no broken links;scripts/docs-pre-commit-check.shpasses (Vale: 0 errors).Checklist