Update android SDK by yashovardhan · Pull Request #2295 · MetaMask/metamask-docs

yashovardhan · 2025-09-10T19:27:34Z

Update android sdk to v10

Note

Migrates Android docs to SDK v10 with new auth flow (connectTo), renamed enums/methods, SFA and smart accounts support, wallet UI updates, and sidebar/version changes.

Android SDK v10 Upgrade:
- Update dependency to web3auth-android-sdk:10.0.0; bump displayed Android PnP version to 10.0.x.
- Add full migration guide sdk/android/migration-guides/android-v9-to-v10.mdx.
API Renames/Breaking Changes:
- Auth: login() → connectTo(); Provider/TypeOfLogin → AuthConnection; LoginConfigItem → AuthConnectionConfig; loginConfig → authConnectionConfig.
- Network/URL: network → web3AuthNetwork (use Web3AuthNetwork); redirectUrl now String.
- Keys: getPrivKey/getEd25519PrivKey → getPrivateKey/getEd25519PrivateKey.
- Wallet Services: launchWalletServices() → showWalletUI(); request() no longer needs ChainConfig and adds smart account methods.
New/Enhanced Features:
- Single Factor Auth (SFA) via idToken in LoginParams.
- Smart accounts and gas sponsorship integrated into Wallet Services.
- Expanded Web3AuthOptions (chains, defaultChainId, walletServicesConfig, enableLogging, useSFAKey).
Docs & Samples Overhaul:
- Revise getting started, advanced config, custom auth, MFA, dApp share, and tutorial to new APIs and enums.
- Add new usage pages: usage/connectTo, usage/getPrivateKey, usage/showWalletUI; remove legacy login, getPrivKey, launchWalletServices pages.
- Update dApp Share response fields (verifier* → authConnection*, verifierId → userId).
Navigation/Sidebar:
- Update ew-sidebar.js to reflect new usage pages and add sdk/android/advanced/smart-accounts entry.

^{Written by Cursor Bugbot for commit ba28ca9. This will update automatically on new commits. Configure here.}

vercel · 2025-09-10T19:27:39Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Preview	Comments	Updated (UTC)
metamask-docs	Error			Oct 1, 2025 6:46am

alexandratran · 2025-09-19T18:40:48Z

embedded-wallets/sdk/android/migration-guides/android-v9-to-v10.mdx

+- [ ] Dependencies updated to v10.x
+- [ ] Imports updated with new package references
+- [ ] `Web3AuthOptions` configuration updated
+- [ ] `login()` calls replaced with `connectTo()`
+- [ ] Private key method names updated
+- [ ] Wallet services methods updated
+- [ ] Dashboard chain configuration verified
+- [ ] Testing completed for all authentication flows


Btw, this doesn't display as a checklist in the rendered markdown: https://metamask-docs-mq9lyhz8p-consensys-ddffed67.vercel.app/embedded-wallets/sdk/android/migration-guides/android-v9-to-v10/#migration-checklist

AyushBherwani1998 · 2025-09-22T07:40:57Z

embedded-wallets/sdk/android/README.mdx

 After instantiating Web3Auth, the next step is to initialize it using the `initialize` method. This method is essential for setting up the SDK, checking for any active sessions, and fetching the whitelabel configuration from your dashboard.

-Once the `initialize` method executes successfully, you can use the `getPrivKey` or `getEd25519PrivKey` methods to verify if an active session exists. If there is no active session, these methods will return an empty string; otherwise, they will return the respective private key.
+Once the `initialize` method executes successfully, you can use the `getPrivateKey` or `getEd25519PrivateKey` methods to verify if an active session exists. If there is no active session, these methods will return an empty string; otherwise, they will return the respective private key.


This is changed, the initialize method will throw an error that needs to be swallowed if the session is not present.

initialize method can fail if the session is not present, or if there is an network issue to get the dashboard configuration, or session validation.

added extra context

AyushBherwani1998 · 2025-09-22T07:46:22Z

embedded-wallets/sdk/android/advanced/README.mdx

+| `web3AuthNetwork` | Defines the Web3Auth Network. It's a mandatory field of type `Web3AuthNetwork`.                                                                                      |
+| `redirectUrl`     | URL that Web3Auth will redirect API responses upon successful authentication from browser. It's a mandatory field of type `String`.                                  |


There are lot of new parameters added. Top of my head, missing default chain id, account abstraction config.

AyushBherwani1998 · 2025-09-22T07:47:27Z

embedded-wallets/sdk/android/advanced/README.mdx

-    var buildEnv: BuildEnv? = BuildEnv.PRODUCTION,
-    @Transient var redirectUrl: Uri,
-    var sdkUrl: String = getSdkUrl(buildEnv),
+    val web3AuthNetwork: Web3AuthNetwork,


Missing few, can't see account abstraction config.

AyushBherwani1998 · 2025-09-22T07:55:05Z

embedded-wallets/sdk/android/advanced/custom-authentication.mdx

+| `ui_locales?`            | The space separated list of language tags, ordered by preference. For instance `fr-CA fr en`.                                                                                                                                    |
+| `id_token_hint?`         | It denotes the previously issued ID token. It takes `String` as a value.                                                                                                                                                         |
+| `id_token?`              | JWT (ID Token) to be passed for login.                                                                                                                                                                                           |
+| `login_hint?`            | Used to specify the user's email address or phone number for Email/SMS Passwordless login flows. Takes a `String` value. For the SMS, the format should be: `+{country_code}-{phone_number}` (e.g. `+1-1234567890`)              |


I think, now we have LoginParams.loginHint which we use for email/sms passwordless, instead of using extra login options.

AyushBherwani1998 · 2025-09-22T07:57:08Z

embedded-wallets/sdk/android/usage/showWalletUI.mdx

+import TabItem from '@theme/TabItem'
+import Tabs from '@theme/Tabs'
+
+The `showWalletUI` method launches a WebView which allows you to use the templated wallet UI services. The method automatically uses the chain configuration from your project settings and no longer requires manual `ChainConfig` parameter. Wallet Services is currently only available for EVM chains.


Missing AccountAbstraction information.

AyushBherwani1998 · 2025-09-22T07:57:44Z

embedded-wallets/sdk/android/usage/request.mdx

+| `appState?`     | It can be used to keep track of the app state. Default is `null`, and accepts `String` as a value.                                                                                                      |
+
+:::warning
+
+The chain configuration is now automatically retrieved from your project settings in the Web3Auth Dashboard. The request will use the appropriate chain based on your project configuration.
+
+:::


Missing account abstraction feature via request to sign user operation.

AyushBherwani1998 · 2025-09-22T07:58:29Z

src/pages/tutorials/android-wallet.mdx

    // ...
    // focus-next-line
-    implementation 'com.github.web3auth:web3auth-android-sdk:7.4.0'
+    implementation 'com.github.web3auth:web3auth-android-sdk:10.0.0'


Page needs revamp, the tutorial is outdated. Lot of breaking changes from 7.4.0, to 10.0.

AyushBherwani1998

Left few comments, also missing account abstraction page.

cursor · 2025-10-01T06:49:53Z

src/pages/tutorials/android-wallet.mdx


    // focus-next-line
-    factory<EthereumUseCase> { EthereumUseCaseImpl(Web3j.build(HttpService(chainConfigList.first().rpcTarget))) }
+    factory<EthereumUseCase> { EthereumUseCaseImpl(Web3j.build(HttpService(chainsList.first().rpcTarget))) }


Bug: Variable Reference Error and Naming Confusion

The chainsList variable is referenced at line 454 before its definition at line 466, which would cause a reference error. This also means the tutorial's code snippets are out of order. Additionally, some comments and text still refer to the old chainConfigList name, which could be confusing.

Additional Locations (1)

src/pages/tutorials/android-wallet.mdx#L466-L467

AyushBherwani1998 · 2025-10-08T11:22:33Z

src/pages/tutorials/android-wallet.mdx

+    // Returns the Ed25519 private key for Solana and other chains.
+    override fun getEd25519PrivateKey(): String {
+      return web3Auth.getEd25519PrivateKey()


tutorial is about EVM, we don't need this.

AyushBherwani1998 · 2025-10-08T11:23:04Z

src/pages/tutorials/android-wallet.mdx

+    // Shows the Wallet UI with smart account support
+    override suspend fun showWalletUI(): CompletableFuture<Void> {
+        return web3Auth.showWalletUI()
+    }
+
+    // Makes a blockchain request
+    override suspend fun request(method: String, params: JsonArray): CompletableFuture<SignResponse> {
+        return web3Auth.request(method, params)


Have you updated the UI, and example to match this? This was not added.

AyushBherwani1998 · 2025-10-08T11:28:19Z

src/pages/tutorials/android-wallet.mdx

+## Advanced Features
+
+### Smart Accounts (ERC-4337)
+
+Web3Auth Android SDK v10.x includes built-in support for smart accounts. When enabled in your dashboard, users automatically get smart contract wallets with advanced features:
+
+```kotlin
+// Check if smart accounts are enabled
+val userInfo = web3AuthHelper.getUserInfo()
+if (userInfo.isSmartAccountEnabled) {
+    val smartAccountAddress = userInfo.smartAccountAddress
+    Log.d("Smart Account", "Address: $smartAccountAddress")
+
+    // Use smart account for gasless transactions
+    val userOp = buildUserOperation(smartAccountAddress, transaction)
+    web3AuthHelper.request("eth_sendUserOperation", userOp)
+}


This whole section is not correct, and using Web3Auth Wallet Services as well. Please check the example, also there's no function/method such as buildUserOperation.

Update android SDK

2942631

yashovardhan requested review from a team as code owners September 10, 2025 19:27

vercel bot deployed to Preview September 10, 2025 19:31 View deployment

Merge branch 'main' into android-updates

9f32e7d

vercel bot deployed to Preview September 11, 2025 08:26 View deployment

alexandratran previously approved these changes Sep 19, 2025

View reviewed changes

AyushBherwani1998 reviewed Sep 22, 2025

View reviewed changes

Updates wrt comments in PR

313073e

yashovardhan dismissed alexandratran’s stale review via 313073e September 24, 2025 19:21

Fix checklist

74d2700

vercel bot deployed to Preview September 24, 2025 19:30 View deployment

yashovardhan and others added 2 commits September 24, 2025 23:34

Add params for web3auth options

ae4c3ab

Merge branch 'main' into android-updates

fa60e76

This comment was marked as outdated.

Sign in to view

vercel bot deployed to Preview September 24, 2025 19:47 View deployment

Delete smart-accounts.mdx

ba28ca9

vercel bot had a problem deploying to Preview October 1, 2025 06:46 Failure

cursor bot reviewed Oct 1, 2025

View reviewed changes

AyushBherwani1998 reviewed Oct 8, 2025

View reviewed changes

		\| `web3AuthNetwork` \| Defines the Web3Auth Network. It's a mandatory field of type `Web3AuthNetwork`. \|
		\| `redirectUrl` \| URL that Web3Auth will redirect API responses upon successful authentication from browser. It's a mandatory field of type `String`. \|

Uh oh!

Conversation

yashovardhan commented Sep 10, 2025 • edited by cursor bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vercel bot commented Sep 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AyushBherwani1998 Sep 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AyushBherwani1998 left a comment

Choose a reason for hiding this comment

Uh oh!

This comment was marked as outdated.

Uh oh!

cursor bot Oct 1, 2025

Choose a reason for hiding this comment

Bug: Variable Reference Error and Naming Confusion

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

yashovardhan commented Sep 10, 2025 •

edited by cursor bot

Loading

vercel bot commented Sep 10, 2025 •

edited

Loading

AyushBherwani1998 Sep 22, 2025 •

edited

Loading