Merge pull request #1051 from Web3Auth/mobile-docs

Update Mobile PnP Docs
Web3Auth · Feb 13, 2025 · a26c8e0 · a26c8e0
2 parents c037836 + 02efa36
commit a26c8e0
Show file tree

Hide file tree

Showing 9 changed files with 87 additions and 28 deletions.
diff --git a/docs/sdk/pnp/android/android.mdx b/docs/sdk/pnp/android/android.mdx
@@ -12,12 +12,6 @@ generated in a non-custodial way on successful user authentication. This authent
 achieved by using any social login options that Web3Auth supports or custom authentication flow of
 your choice.
 
-## Requirements
-
-- Android API version `24` or newer.
-- Android Compile and Target SDK: `34`.
-- Basic knowledge of Java or Kotlin Development.
-
 ## Resources
 
 - [Quick Start](/quick-start?product=PNP&sdk=PNP_ANDROID&framework=ANDROID&stepIndex=0): Get Started

diff --git a/docs/sdk/pnp/android/install.mdx b/docs/sdk/pnp/android/install.mdx
@@ -11,6 +11,12 @@ import Whitelist from "@site/src/common/sdk/pnp/android/_android-whitelist.mdx";
 import Deeplinking from "@site/src/common/sdk/pnp/android/_android-deep-linking.mdx";
 import ManifestChanges from "@site/src/common/sdk/pnp/android/_android-manifest-changes.mdx";
 
+## Requirements
+
+- Android API version `24` or newer.
+- Android Compile and Target SDK: `34`.
+- Basic knowledge of Java or Kotlin Development.
+
 ## Installation
 
 <UpdateGradle />

diff --git a/docs/sdk/pnp/android/usage.mdx b/docs/sdk/pnp/android/usage.mdx
@@ -14,6 +14,19 @@ import EnableMFAMethod from "@site/src/common/sdk/pnp/android/_enable-mfa.mdx";
 Web3Auth's Android SDK is a set of libraries and tools that allow you to easily integrate Web3 with
 Android applications.
 
+## Functionality Overview
+
+| Name                                            | Description                                                                                                                                           |
+| ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [login](#logging-in-a-user)                     | Logs in the user with the selected login provider.                                                                                                    |
+| [logout](#logging-out-a-user)                   | Logs out the user from the currently active session.                                                                                                  |
+| [getPrivKey](#secp256k1-private-key)            | Retrieve the user's secp256K1 key. The key can be used to sign transactions for chains using the secp256k1 curve like EVM-compatible chains.          |
+| [getEd25519PrivKey](#ed25519-private-key)       | Retrieve the user's ed25519 key. The key can be used to sign transactions for chains using the ed25519 curve like Solana, Near, Algorand, and others. |
+| [getUserInfo](#retrieve-user-information)       | Retrieve the user information, such as login provider, name, email, oAuth token, etc.                                                                 |
+| [enableMFA](#enable-mfa-for-a-user)             | Use to trigger the setup MFA flow for the users.                                                                                                      |
+| [launchWalletServices](#launch-wallet-services) | Use to open the templated wallet UI in WebView.                                                                                                       |
+| [request](#request-signature)                   | Use to open templated transaction screens for signing EVM transactions.                                                                               |
+
 ## Logging in a User
 
 To login in a user, you can use the `login` method. It will trigger login flow will navigate the
@@ -336,13 +349,14 @@ val privateKey = web3Auth.getPrivKey()
 ### Ed25519 Private Key
 
 To retrieve the secp256k1 private key of the user., use `getEd25519PrivKey` method. This private key
-can be used to sign transactions on Solana.
+can be used to sign transactions on Solana, Near, Algorand, and other chains that use the ed25519
+curve.
 
 ```kotlin
 val privateKey = web3Auth.getEd25519PrivKey()
 ```
 
-## Retrive User Information
+## Retrieve User Information
 
 You can use the `getUserInfo` method to retrieve various details about the user, such as their login
 type, whether multi-factor authentication (MFA) is enabled, profile image, name, and other relevant
@@ -472,8 +486,8 @@ val completableFuture = web3Auth.launchWalletServices(
 ## Request signature
 
 The `request` method facilitates the use of templated transaction screens for signing transactions.
-Upon successful completion, you can retrieve the signature for the request using the
-`getSignResponse` static method.
+The method will return [SignResponse](#signresponse). It can be used to sign transactions for any
+EVM chain and screens can be whitelabeled to your branding.
 
 Please check the list of
 [JSON RPC methods](https://docs.metamask.io/wallet/reference/json-rpc-api/), noting that the request
@@ -524,3 +538,11 @@ signMsgCompletableFuture.whenComplete { signResult, error ->
     }
 }
 ```
+
+### SignResponse
+
+| Name      | Description                                                   |
+| --------- | ------------------------------------------------------------- |
+| `success` | Determines whether the request was successful or not.         |
+| `result?` | Holds the signature for the request when `success` is `true`. |
+| `error?`  | Holds the error for the request when `success` is `false`.    |
diff --git a/docs/sdk/pnp/flutter/flutter.mdx b/docs/sdk/pnp/flutter/flutter.mdx
@@ -11,11 +11,6 @@ It returns a private key generated in a non-custodial way on successful user aut
 authentication is achieved by using any of the supported social logins Web3Auth provides or using a
 custom authentication flow of your choice.
 
-## Requirements
-
-- **Android** API version 26 or newer.
-- **iOS** 14, Xcode 12+ and Swift 5.x
-
 ## Resources
 
 - [Quick Start](/quick-start?product=PNP&sdk=PNP_FLUTTER&framework=ANDROID&stepIndex=1&stepIndex=0):

diff --git a/docs/sdk/pnp/flutter/install.mdx b/docs/sdk/pnp/flutter/install.mdx
@@ -17,6 +17,11 @@ import SPM from "@site/src/common/sdk/pnp/ios/_spm.mdx";
 import Cocoapods from "@site/src/common/sdk/pnp/ios/_cocoapods.mdx";
 import IOSWhitelist from "@site/src/common/sdk/pnp/ios/ios-whitelist.mdx";
 
+## Requirements
+
+- **Android** API version 26 or newer.
+- **iOS** 14, Xcode 12+ and Swift 5.x
+
 ## Installation
 
 <FlutterInstallation />

diff --git a/docs/sdk/pnp/flutter/usage.mdx b/docs/sdk/pnp/flutter/usage.mdx
@@ -10,6 +10,19 @@ import FlutterResponse from "@site/src/common/sdk/pnp/_userinfo_response.mdx";
 import SMSPasswordless from "@site/src/common/sdk/pnp/flutter/_sms_passwordless.mdx";
 import EnableMFAMethod from "@site/src/common/sdk/pnp/flutter/_enable-mfa.mdx";
 
+## Functionality Overview
+
+| Name                                            | Description                                                                                                                                           |
+| ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [login](#logging-in-a-user)                     | Logs in the user with the selected login provider.                                                                                                    |
+| [logout](#logging-out-a-user)                   | Logs out the user from the currently active session.                                                                                                  |
+| [getPrivKey](#secp256k1-private-key)            | Retrieve the user's secp256K1 key. The key can be used to sign transactions for chains using the secp256k1 curve like EVM-compatible chains.          |
+| [getEd25519PrivKey](#ed25519-private-key)       | Retrieve the user's ed25519 key. The key can be used to sign transactions for chains using the ed25519 curve like Solana, Near, Algorand, and others. |
+| [getUserInfo](#retrieve-user-information)       | Retrieve the user information, such as login provider, name, email, oAuth token, etc.                                                                 |
+| [enableMFA](#enable-mfa-for-a-user)             | Use to trigger the setup MFA flow for the users.                                                                                                      |
+| [launchWalletServices](#launch-wallet-services) | Use to open the templated wallet UI in WebView.                                                                                                       |
+| [request](#request-signature)                   | Use to open templated transaction screens for signing EVM transactions.                                                                               |
+
 ## Logging in a User
 
 To login in a user, you can use the `login` method. It will trigger login flow will navigate the
@@ -410,13 +423,14 @@ final privateKey = await Web3AuthFlutter.getPrivKey();
 ### Ed25519 Private Key
 
 To retrieve the secp256k1 private key of the user., use `getEd25519PrivKey` method. This private key
-can be used to sign transactions on Solana.
+can be used to sign transactions on Solana, Near, Algorand, and other chains that use the ed25519
+curve.
 
 ```dart
 final privateKey = await Web3AuthFlutter.getEd25519PrivKey();
 ```
 
-## Retrive User Information
+## Retrieve User Information
 
 You can use the `getUserInfo` method to retrieve various details about the user, such as their login
 type, whether multi-factor authentication (MFA) is enabled, profile image, name, and other relevant
@@ -586,8 +600,8 @@ try {
 ## Request signature
 
 The `request` method facilitates the use of templated transaction screens for signing transactions.
-Upon successful completion, you can retrieve the signature for the request using the
-`getSignResponse` static method.
+The method will return [SignResponse](#signresponse). It can be used to sign transactions for any
+EVM chain and screens can be whitelabeled to your branding.
 
 Please check the list of
 [JSON RPC methods](https://docs.metamask.io/wallet/reference/json-rpc-api/), noting that the request
@@ -632,3 +646,11 @@ try {
   log("Unknown exception occurred");
 }
 ```
+
+### SignResponse
+
+| Name      | Description                                                   |
+| --------- | ------------------------------------------------------------- |
+| `success` | Determines whether the request was successful or not.         |
+| `result?` | Holds the signature for the request when `success` is `true`. |
+| `error?`  | Holds the error for the request when `success` is `false`.    |
diff --git a/docs/sdk/pnp/ios/install.mdx b/docs/sdk/pnp/ios/install.mdx
@@ -8,6 +8,12 @@ import SPM from "@site/src/common/sdk/pnp/ios/_spm.mdx";
 import Cocoapods from "@site/src/common/sdk/pnp/ios/_cocoapods.mdx";
 import Whitelist from "@site/src/common/sdk/pnp/ios/ios-whitelist.mdx";
 
+## Requirements
+
+- iOS 14+
+- Xcode 12+
+- Swift 5.x
+
 ## Swift Package Manager
 
 <SPM />

diff --git a/docs/sdk/pnp/ios/ios.mdx b/docs/sdk/pnp/ios/ios.mdx
@@ -12,12 +12,6 @@ a private key generated in a non custodial way on successful authentication of t
 authentication can be achieved by using any of the social logins Web3Auth provides or using a custom
 authentication flow of your choice.
 
-### Requirements
-
-- iOS 14+
-- Xcode 12+
-- Swift 5.x
-
 ## Resources
 
 - [Quick Start](/quick-start?product=PNP&sdk=PNP_IOS&framework=IOS&stepIndex=0): Get Started with an

diff --git a/docs/sdk/pnp/ios/usage.mdx b/docs/sdk/pnp/ios/usage.mdx
@@ -11,6 +11,19 @@ import Tabs from "@theme/Tabs";
 import SMSPasswordless from "@site/src/common/sdk/pnp/ios/_sms_passwordless.mdx";
 import EnableMFAMethod from "@site/src/common/sdk/pnp/ios/_enable-mfa.mdx";
 
+## Functionality Overview
+
+| Name                                            | Description                                                                                                                                           |
+| ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [login](#logging-in-a-user)                     | Logs in the user with the selected login provider.                                                                                                    |
+| [logout](#logging-out-a-user)                   | Logs out the user from the currently active session.                                                                                                  |
+| [getPrivKey](#secp256k1-private-key)            | Retrieve the user's secp256K1 key. The key can be used to sign transactions for chains using the secp256k1 curve like EVM-compatible chains.          |
+| [getEd25519PrivKey](#ed25519-private-key)       | Retrieve the user's ed25519 key. The key can be used to sign transactions for chains using the ed25519 curve like Solana, Near, Algorand, and others. |
+| [getUserInfo](#retrieve-user-information)       | Retrieve the user information, such as login provider, name, email, oAuth token, etc.                                                                 |
+| [enableMFA](#enable-mfa-for-a-user)             | Use to trigger the setup MFA flow for the users.                                                                                                      |
+| [launchWalletServices](#launch-wallet-services) | Use to open the templated wallet UI in WebView.                                                                                                       |
+| [request](#request-signature)                   | Use to open templated transaction screens for signing EVM transactions.                                                                               |
+
 ## Logging in a User
 
 To login in a user, you can use the `login` method. It will trigger login flow will navigate the
@@ -281,13 +294,14 @@ let privateKey = web3Auth.getPrivKey();
 ### Ed25519 Private Key
 
 To retrieve the secp256k1 private key of the user., use `getEd25519PrivKey` method. This private key
-can be used to sign transactions on Solana.
+can be used to sign transactions on Solana, Near, Algorand, and other chains that use the ed25519
+curve.
 
 ```swift
 let privateKey = web3Auth.getEd25519PrivKey();
 ```
 
-## Retrive User Information
+## Retrieve User Information
 
 You can use the `getUserInfo` method to retrieve various details about the user, such as their login
 type, whether multi-factor authentication (MFA) is enabled, profile image, name, and other relevant
@@ -423,7 +437,8 @@ do {
 ## Request signature
 
 The `request` method facilitates the use of templated transaction screens for signing transactions.
-The method will return [SignResponse](#signresponse).
+The method will return [SignResponse](#signresponse). It can be used to sign transactions for any
+EVM chain and screens can be whitelabeled to your branding.
 
 Please check the list of
 [JSON RPC methods](https://docs.metamask.io/wallet/reference/json-rpc-api/), noting that the request