Skip to content

Commit 01769ca

Browse files
authored
Merge branch 'master' into flutter-v6
2 parents 3ef27d5 + cf1db33 commit 01769ca

File tree

23 files changed

+224
-53
lines changed

23 files changed

+224
-53
lines changed
Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
---
2+
title: Account Dashboard
3+
description: "Account Dashboard | Documentation - Web3Auth"
4+
---
5+
6+
# Account Dashboard
7+
8+
Web3Auth's Account Dashboard provides a unified platform for users to manage their Multi-Factor
9+
Authentication (MFA) and account security with ease. This document provides an overview of its
10+
features and how to integrate it seamlessly into your application.
11+
12+
![Unified Recovery Management Screenshot](/images/account-dashboard/unified-recovery-management.jpg)
13+
14+
### 1. Unified Recovery Management
15+
16+
The Account Dashboard allows users to:
17+
18+
- Set up recovery factors such as Password, Social Recovery, Authenticator App, and Recovery Phrase.
19+
- Manage and modify existing recovery factors.
20+
21+
With these features, users can strengthen their account security effortlessly.
22+
23+
Additionally, users can:
24+
25+
- Unhide and copy their backup phrase for safekeeping.
26+
- Resend the recovery phrase to their registered email address if forgotten.
27+
- Add or remove MFA factors as needed for enhanced security.
28+
29+
The Account Dashboard allows users to:
30+
31+
- Set up recovery factors such as Password, Social Recovery, Authenticator App, and Recovery Phrase.
32+
- Manage and modify existing recovery factors.
33+
34+
With these features, users can strengthen their account security effortlessly.
35+
![Account Dashboard Overview Screenshot](/images/account-dashboard/account-dashboard-overview.jpg)
36+
37+
### 2. Device Overview
38+
39+
Users can view and manage all devices connected to their account, ensuring complete control over
40+
their sessions. They can:
41+
42+
- Add trusted devices.
43+
- Remove unused or unauthorized devices.
44+
- Set current devices as default for enhanced convenience.
45+
46+
![Device Overview Screenshot](/images/account-dashboard/device-overview.jpg)
47+
48+
### 3. Security Insights
49+
50+
A visual indicator displays the overall security status of the account, encouraging users to set up
51+
additional recovery factors for better protection.
52+
53+
![Security Insights Screenshot](/images/account-dashboard/security-insights.jpg)
54+
55+
## Setup and Integration
56+
57+
### Implementation in Your dApp
58+
59+
Integrate the Account Dashboard with your dApp by embedding it as part of your user flow. This
60+
provides users with:
61+
62+
- Seamless access to recovery factor setup.
63+
- Quick device management.
64+
- Real-time security insights.
65+
66+
### Enhance User Security
67+
68+
We recommend encouraging your users to:
69+
70+
1. Set up at least three recovery factors.
71+
2. Regularly review their connected devices.
72+
3. Enable advanced security measures like passkeys and authenticator apps.
73+
74+
## FAQs
75+
76+
### Can users access the Account Dashboard without logging in?
77+
78+
No, the Account Dashboard is secured and can only be accessed after successful authentication.
79+
80+
### What recovery factors are supported?
81+
82+
The Account Dashboard supports the following recovery factors:
83+
84+
- Social Recovery
85+
- Recovery Phrase
86+
- Password
87+
- Authenticator App
88+
- Passkeys

docs/features/wallet-ui.mdx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,13 @@ you can use this feature for projects on `sapphire_devnet` for free.
1717

1818
:::
1919

20+
:::note
21+
22+
From the **v9.5.0 release**, the Embedded Wallet UI supports both Externally Owned Accounts (EOA)
23+
and Account Abstraction (AA) accounts in the Wallet Services.
24+
25+
:::
26+
2027
## Enhancing User Experience with Embedded Wallet UI
2128

2229
Web3Auth's Embedded Wallet UI service is engineered to blend effortlessly into your application,
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
title: PnP iOS SDK - v9 to v10
3+
description: "PnP iOS SDK - v9 to v10 | Documentation - Web3Auth"
4+
sidebar_label: v9 to v10
5+
---
6+
7+
This migration guide provides steps for upgrading from version v9 to v10 of the PnP iOS SDK. The
8+
guide outlines significant changes and enhancements, including the support of Web3Auth OpenLogin
9+
version v9, and Wallet Services v3.
10+
11+
## Breaking Changes
12+
13+
### `getSignResponse` is now removed.
14+
15+
In v10, we try to improve the developer experience by removing the `getSignResponse` method and
16+
returning the result in the `request` method itself.
17+
18+
Previously, after calling the `request` method, developers had to use the `getSignResponse` method
19+
to retrieve the `SignResponse`. In the latest version v10, the `request` method will return the
20+
`SignResponse` directly.
21+
22+
```swift
23+
// remove-next-line
24+
try await self.web3Auth?.request(
25+
// add-next-line
26+
let response = try await self.web3Auth?.request(
27+
chainConfig: ChainConfig(
28+
chainId: "0x89",
29+
rpcTarget: "https://polygon.llamarpc.com"
30+
),
31+
method: "personal_sign",
32+
requestParams: params
33+
)
34+
35+
36+
// remove-next-line
37+
let response = try Web3Auth.getSignResponse()
38+
if response!.success {
39+
print(response!.result!)
40+
} else {
41+
print(response!.error!)
42+
}
43+
44+
```
45+
46+
## Enhancements
47+
48+
In the latest version v10, we have added support for the Web3Auth Auth Service version v9, and
49+
Wallet Services v3. In Wallet Services v3, the prebuilt wallet UI now supports the swap
50+
functionality allowing users to swap to their favorite token from the app itself.

docs/sdk/mpc-core-kit/mpc-core-kit-js/mpc-core-kit-js.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -163,8 +163,8 @@ device seamlessly without having to generate a new factor.
163163

164164
## Resources
165165

166-
- [Quick Start](/quick-start?product=CORE_KIT&sdk=MPC_CORE_KIT&framework=REACT&stepIndex=0): Get
167-
Started with an easy to follow integration of Web3Auth
166+
- [Quick Start](/quick-start?product=MPC_CORE_KIT&sdk=MPC_CORE_KIT_WEB&framework=REACT&stepIndex=0&stepIndex=0):
167+
Get Started with an easy to follow integration of Web3Auth
168168

169169
- [Example Applications](/examples?product=Core+Kit&sdk=MPC+Core+Kit): Explore our example
170170
applications and try the SDK yourself.

docs/sdk/pnp/ios/ios.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ authentication flow of your choice.
1414

1515
### Requirements
1616

17-
- iOS 14
17+
- iOS 14+
1818
- Xcode 12+
1919
- Swift 5.x
2020

docs/sdk/pnp/ios/usage.mdx

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -423,8 +423,7 @@ do {
423423
## Request signature
424424

425425
The `request` method facilitates the use of templated transaction screens for signing transactions.
426-
Upon successful completion, you can retrieve the signature for the request using the
427-
`getSignResponse` static method.
426+
The method will return [SignResponse](#signresponse).
428427

429428
Please check the list of
430429
[JSON RPC methods](https://docs.metamask.io/wallet/reference/json-rpc-api/), noting that the request
@@ -451,7 +450,7 @@ do {
451450
params.append(address)
452451

453452
// focus-start
454-
try await self.web3Auth?.request(
453+
let response = try await self.web3Auth?.request(
455454
chainConfig: ChainConfig(
456455
chainId: "11155111",
457456
rpcTarget: "https://eth-sepolia.public.blastapi.io"
@@ -461,17 +460,23 @@ do {
461460
)
462461
// focus-end
463462

464-
// focus-next-line
465-
let response = try Web3Auth.getSignResponse()
466-
467-
if response!.success {
463+
if response!.success {
468464
print(response!.result!)
469465
} else {
470466
// Handle Error
471467
print(response!.error!)
472468
}
469+
473470
} catch {
474471
print(error.localizedDescription)
475472
// Handle error
476473
}
477474
```
475+
476+
### SignResponse
477+
478+
| Name | Description |
479+
| --------- | ------------------------------------------------------------- |
480+
| `success` | Determines whether the request was successful or not. |
481+
| `result?` | Holds the signature for the request when `success` is `true`. |
482+
| `error?` | Holds the error for the request when `success` is `false`. |

docs/sdk/sfa/sfa-android/sfa-android.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ SDKs. You can use this SDK with all features enabled in `sapphire_devnet` for fr
3232

3333
## Resources
3434

35-
- [Quick Start](/quick-start?product=CORE_KIT&sdk=SFA_ANDROID&framework=ANDROID&stepIndex=0): Get
36-
Started with an easy to follow integration of Web3Auth
35+
- [Quick Start](/quick-start?product=SFA&sdk=SFA_ANDROID&framework=ANDROID&stepIndex=0): Get Started
36+
with an easy to follow integration of Web3Auth
3737

3838
- [Example Applications](/examples?product=Core+Kit&sdk=Single+Factor+Auth+Android+SDK): Explore our
3939
example applications and try the SDK yourself.

docs/sdk/sfa/sfa-flutter/sfa-flutter.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ SDKs. You can use this SDK with all features enabled in `sapphire_devnet` for fr
3333

3434
## Resources
3535

36-
- [Quick Start](/quick-start?product=CORE_KIT&sdk=SFA_FLUTTER&framework=IOS&stepIndex=0): Get
37-
Started with an easy to follow integration of Web3Auth
36+
- [Quick Start](/quick-start?product=SFA&sdk=SFA_FLUTTER&framework=IOS&stepIndex=0): Get Started
37+
with an easy to follow integration of Web3Auth
3838

3939
- [Example Applications](/examples?product=Core+Kit&sdk=Single+Factor+Auth+Flutter+SDK): Explore our
4040
example applications and try the SDK yourself.

docs/sdk/sfa/sfa-ios/sfa-ios.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@ SDKs. You can use this SDK with all features enabled in `sapphire_devnet` for fr
3535

3636
## Resources
3737

38-
- [Quick Start](/quick-start?product=CORE_KIT&sdk=SFA_IOS&framework=IOS&stepIndex=0): Get Started
39-
with an easy to follow integration of Web3Auth
38+
- [Quick Start](/quick-start?product=SFA&sdk=SFA_IOS&framework=IOS&stepIndex=0): Get Started with an
39+
easy to follow integration of Web3Auth
4040

4141
- [Example Applications](/examples?product=Core+Kit&sdk=Single+Factor+Auth+iOS+SDK): Explore our
4242
example applications and try the SDK yourself.

docs/sdk/sfa/sfa-js/sfa-js.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@ SDKs. You can use this SDK with all features enabled in `sapphire_devnet` for fr
3737

3838
## Resources
3939

40-
- [Quick Start](/quick-start?product=CORE_KIT&sdk=SFA_WEB&framework=REACT&stepIndex=0): Get Started
41-
with an easy-to-follow integration of Web3Auth
40+
- [Quick Start](/quick-start?product=SFA&sdk=SFA_WEB&framework=REACT&stepIndex=0): Get Started with
41+
an easy-to-follow integration of Web3Auth
4242

4343
- [Example Applications](/examples?product=Core+Kit&sdk=Single+Factor+Auth+JS+SDK): Explore our
4444
example applications and try the SDK yourself.

0 commit comments

Comments
 (0)