Skip to content
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.

Sign up for GitHub

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

Update SFA Mobile Docs for Alpha #1052

Closed
wants to merge 2 commits into from
Closed

Update SFA Mobile Docs for Alpha #1052

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2553758
wip
AyushBherwani1998 Feb 11, 2025
11c4cf5
update sfa sdk docs to alpha
AyushBherwani1998 Feb 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions docs/sdk/sfa/sfa-android/initialize.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,15 @@ that the initialization process is critical to the successful use of Web3Auth.
In your activity, create a `SingleFactorAuth` instance with `Web3AuthOptions`. You can define the
Web3Auth network, client id, and other parameters during initialization.

| Parameter | Description |
| ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `network` | The Web3auth network is to be used by the SDK. Supported values are `Web3AuthNetwork.SAPPHIRE_MAINNET`, `Web3AuthNetwork.SAPPHIRE_DEVNET` ,`Web3AuthNetwork.MAINNET`, `Web3AuthNetwork.TESTNET`, `Web3AuthNetwork.CYAN`, and `Web3AuthNetwork.AQUA` |
| `clientId` | The clientId for your Web3Auth project. You can get it from [Web3Auth dashboard](https://dashboard.web3auth.io/). |
| `sessionTime` | Specifies the session duration in seconds. By default, the value is set to 86400 seconds (1 day), with a maximum session duration of up to 30 days. |
| `serverTimeOffset` | Specify a custom server time offset. The default value is 0. |
| `storageServerUrl?` | Specifies the storage server URL. The default value is `https://session.web3auth.io`. |
| Parameter | Description |
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `network` | The Web3auth network is to be used by the SDK. Supported values are `Web3AuthNetwork.SAPPHIRE_MAINNET`, `Web3AuthNetwork.SAPPHIRE_DEVNET` ,`Web3AuthNetwork.MAINNET`, `Web3AuthNetwork.TESTNET`, `Web3AuthNetwork.CYAN`, and `Web3AuthNetwork.AQUA` |
| `clientId` | The clientId for your Web3Auth project. You can get it from [Web3Auth dashboard](https://dashboard.web3auth.io/). |
| `sessionTime` | Specifies the session duration in seconds. By default, the value is set to 86400 seconds (1 day), with a maximum session duration of up to 30 days. |
| `serverTimeOffset` | Specify a custom server time offset. The default value is 0. |
| `storageServerUrl?` | Specifies the storage server URL. The default value is `https://session.web3auth.io`. |
| `whiteLabel?` | You can pass the white labeling options for web3auth. It helps you define your brand app's custom UI, and branding for the Wallet Services feature. The recommended way to configure the `whiteLabel` is through the Web3Auth Dashboard. [Learn how to configure the `whiteLabel` via Web3Auth Dashboard](/docs/features/whitelabel#new-whitelabeling-via-the-dashboard). |
| `redirectUri?` | URL that Web3Auth will redirect API responses upon successful `request` method call. Please note, that it's mandatory to configure the `redirectUri` if you are using the `request` method. |

## Create Instance

Expand Down
162 changes: 158 additions & 4 deletions docs/sdk/sfa/sfa-android/usage.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,14 @@ you'll see an Error message.

The SingleFactorAuth instance natively provides the following methods:

- [connect](#login-user) - Use to login user and retrive private key pair.
- [logout](#logout-user) - Use to logout existing user.
- [connected](#check-users-logged-in-status) - Use to check whether the user is logged in or not.
- [getSessionData](#get-session-data) - This method helps to get the session data for valid session.
| Method | Description |
| ------------------------------------------ | ------------------------------------------------------------------- |
| [connect](#login-user) | Use to login user and retrieve private key pair. |
| [logout](#logout-user) | Use to logout existing user. |
| [connected](#check-users-logged-in-status) | Use to check whether the user is logged in or not. |
| [getSessionData](#get-session-data) | This method helps to get the session data for valid session. |
| [showWalletUI ](#show-wallet-ui) | Use to open templated the wallet UI in WebView. |
| [request](#request-signature) | Use to open templated transaction screens for signing transactions. |

## Login User

Expand Down Expand Up @@ -165,3 +169,153 @@ The `SessionData` has the following properties to retrive the relevant session i
| `publicAddress` | Retrieves the user's public address. |
| `userInfo?` | Retrieves the user's information like email, name, verifier id, and more. |
| `signatures?` | Retrieves the node's signatures that are returned for request. |

## Show Wallet UI

The `showWalletUI` method launches a WebView which allows you to use the templated wallet UI
services. The method takes `ChainConfig` as the required input. Wallet Services is currently only
available for EVM chains.

:::note

Access to Wallet Services is gated. You can use this feature in `sapphire_devnet` for free. The
minimum [pricing plan](https://web3auth.io/pricing.html) to use this feature in a production
environment is the **Scale Plan**.

:::

![Wallet Services](/images/mobile-wallet-services.png)

### Parameters

<Tabs
defaultValue="table"
values={[
{ label: "Table", value: "table" },
{ label: "Class", value: "class" },
]}
>

<TabItem value="table">

| Parameter | Description |
| ------------------- | --------------------------------------------------------------------------------------------------------------------------- |
| `chainNamespace` | Custom configuration for your preferred blockchain. As of now only EVM supported. Default value is `ChainNamespace.EIP155`. |
| `decimals?` | Number of decimals for the currency ticker. Default value is 18, and accepts `Int` as value. |
| `blockExplorerUrl?` | Blockchain's explorer URL. (eg: `https://etherscan.io`) |
| `chainId` | The chain id of the selected blockchain in hex `String`. |
| `displayName?` | Display Name for the chain. |
| `logo?` | Logo for the selected `chainNamespace` & `chainId`. |
| `rpcTarget` | RPC Target URL for the selected `chainNamespace` & `chainId`. |
| `ticker?` | Default currency ticker of the network (e.g: `ETH`) |
| `tickerName?` | Name for currency ticker (e.g: `Ethereum`) |

</TabItem>

<TabItem value="class">

```kotlin
data class ChainConfig(
val chainNamespace: ChainNamespace = ChainNamespace.EIP155,
val decimals: Int? = 18,
val blockExplorerUrl: String? = null,
val chainId: String,
val displayName: String? = null,
val logo: String? = null,
val rpcTarget: String,
val ticker: String? = null,
val tickerName: String? = null,
)
```

</TabItem>
</Tabs>

### Usage

```kotlin
val chainConfig = ChainConfig(
chainId = "0x1",
rpcTarget = "https://rpc.ankr.com/eth",
ticker = "ETH",
chainNamespace = ChainNamespace.EIP155
)

// focus-start
val completableFuture = singleFactorAuth.showWalletUI(
chainConfig
)
// focus-end

completableFuture.whenComplete { _, error ->
if (error == null) {
Log.d("Successful", "Wallet launched successfully")
} else {
Log.d("Error", error.message ?: "Something went wrong")
}
}
```

## Request signature

The `request` method facilitates the use of templated transaction screens for signing transactions.
These screens can be used to sign transactions for any EVM chain and 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
method currently supports only the signing methods.

![Request Method](/images/mobile-request-method.png)

### Parameters

| Parameter | Description |
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `chainConifg` | Defines the chain to be used for signature request. Learn more about [ChainConfig](#parameters-1). |
| `method` | JSON RPC method name in `String`. Currently, the request method only supports the singing methods. |
| `requestParams` | Parameters for the corresponding method. The parameters should be in the list and correct sequence. Take a look at [RPC methods](https://docs.metamask.io/wallet/reference/json-rpc-api/) to know more. |

### Usage

```kotlin
val params = JsonArray().apply {
// Message to be signed
add("Hello, World!")
// User's EOA address
add(address)
}

val chainConfig = ChainConfig(
chainId = "0x1",
rpcTarget = "https://rpc.ankr.com/eth",
ticker = "ETH",
chainNamespace = ChainNamespace.EIP155
)

// focus-start
val signMsgCompletableFuture = singleFactorAuth.request(
chainConfig = chainConfig,
"personal_sign",
requestParams = params
)
// focus-end

signMsgCompletableFuture.whenComplete { signResult, error ->
if (error == null) {
// focus-next-line
Log.d("Sign Result", signResult.toString())

} else {
Log.d("Sign Error", error.message ?: "Something went wrong")
}
}
```

### 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`. |
16 changes: 9 additions & 7 deletions docs/sdk/sfa/sfa-ios/initialize.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,15 @@ according to the preference of your project.
The `SingleFactoreAuth` constructor takes an object called `Web3AuthOptions` as input. The
constructor parameters are listed below

| Parameter | Description |
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `clientId` | Your Web3Auth Client Id from [Web3Auth Dashboard](https://dashboard.web3auth.io/). |
| `web3AuthNetwork` | The Web3auth network to be used by the SDK. Supported values are `.SAPPHIRE_MAINNET`, `.SAPPHIRE_DEVNET`, `.MAINNET`, `.TESTNET`, `.CYAN`, and `.AQUA` |
| `sessionTime` | Specifies the session duration in seconds. By default, the value is set to 86400 seconds (1 day), with a maximum session duration of up to 30 days. |
| `serverTimeOffset` | Specifies the server time offset in seconds. This parameter is used to adjust the server time to the local time. The default value is 0 seconds. |
| `storageServerUrl?` | Specifies the storage server URL. The default value is `https://session.web3auth.io`. |
| Parameter | Description |
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `clientId` | Your Web3Auth Client Id from [Web3Auth Dashboard](https://dashboard.web3auth.io/). |
| `web3AuthNetwork` | The Web3auth network to be used by the SDK. Supported values are `.SAPPHIRE_MAINNET`, `.SAPPHIRE_DEVNET`, `.MAINNET`, `.TESTNET`, `.CYAN`, and `.AQUA` |
| `sessionTime` | Specifies the session duration in seconds. By default, the value is set to 86400 seconds (1 day), with a maximum session duration of up to 30 days. |
| `serverTimeOffset` | Specifies the server time offset in seconds. This parameter is used to adjust the server time to the local time. The default value is 0 seconds. |
| `storageServerUrl?` | Specifies the storage server URL. The default value is `https://session.web3auth.io`. |
| `whiteLabel?` | You can pass the white labeling options for web3auth. It helps you define your brand app's custom UI, and branding for the Wallet Services feature. The recommended way to configure the `whiteLabel` is through the Web3Auth Dashboard. [Learn how to configure the `whiteLabel` via Web3Auth Dashboard](/docs/features/whitelabel#new-whitelabeling-via-the-dashboard). |
| `redirectUrl?` | URL that Web3Auth will redirect API responses upon successful `request` method call. Please note, that it's mandatory to configure the `redirectUri` if you are using the `request` method. |

## Create instance

Expand Down
Loading