Skip to content

Commit 0d582c3

Browse files
shahbaz17shahbaz17
committed
Fix docs reported issues
More to follow
1 parent 28826b8 commit 0d582c3

File tree

12 files changed

+55
-28
lines changed

12 files changed

+55
-28
lines changed

‎docs/sdk/pnp/web/adapters/auth.mdx‎

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ import ExtraLoginOptions from "@site/src/common/sdk/pnp/web/_extra-login-options
1919
import CustomAuthenticationCoreExample from "@site/src/common/sdk/pnp/web/_custom-authentication-core-example.mdx";
2020
import CustomAuthenticationWeb3AuthExample from "@site/src/common/sdk/pnp/web/_custom-authentication-web3auth-example.mdx";
2121
import ConnectToExample from "@site/src/common/sdk/pnp/web/_connect-to-example.mdx";
22+
import MFAMinimumPlan from "@site/src/common/docs/_mfa_minimum_plan.mdx";
2223

2324
## [`@web3auth/auth-adapter`](https://npmjs.com/package/@web3auth/auth-adapter)
2425

@@ -144,10 +145,14 @@ their order. Currently, there are four values for `mfaLevel`:
144145

145146
We offer the following backup factors under `mfaSettings`:
146147

148+
<MFAMinimumPlan />
149+
147150
- `deviceShareFactor`,
148151
- `backUpShareFactor`,
149-
- `socialBackupFactor`, and
150-
- `passwordFactor`.
152+
- `socialBackupFactor`,
153+
- `passwordFactor`,
154+
- `authenticatorFactor`, and
155+
- `passkeysFactor`.
151156

152157
### Example
153158

@@ -179,6 +184,16 @@ const authAdapter = new AuthAdapter({
179184
priority: 4,
180185
mandatory: false,
181186
},
187+
authenticatorFactor: {
188+
enable: true,
189+
priority: 5,
190+
mandatory: false,
191+
},
192+
passkeysFactor: {
193+
enable: true,
194+
priority: 6,
195+
mandatory: false,
196+
},
182197
},
183198
},
184199
});

‎docs/sdk/pnp/web/modal/mfa.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ enabled MFA on other dApps. This is because MFA cannot be turned off once it is
3434

3535
:::
3636

37-
<MFAMinimumPlan />
37+
{/* <MFAMinimumPlan /> */}
3838

3939
## Installing Auth Adapter
4040

‎docs/sdk/pnp/web/modal/usage.mdx‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,8 @@ Finally, with the Wallet Services Plugin, you can enable additional functionalit
4646
- `showCheckout()` - Initiate Topup for the user.
4747
- `showWalletConnectScanner()` - Show WalletConnect QR Code Scanner.
4848
- `showWalletUI()` - Show Embedded Wallet UI.
49+
- `showSwap()` - Show Swap UI.
50+
- `showTransactionConfirmation()` - Show Transaction Confirmation UI.
4951

5052
## Logging in the User
5153

@@ -148,7 +150,12 @@ local currency and specify the token to top up their wallet.
148150
You can use the `showWalletUI` function to show the templated wallet UI services.
149151
[Learn more about `showWalletUI`](/docs/sdk/pnp/web/wallet-services/usage#show-wallet-embedded-ui).
150152

151-
### Transaction Confirmatons Screen
153+
### Swap Screen
154+
155+
You can use the `showSwap` function to show the Swap UI.
156+
[Learn more about `showSwap`](/docs/sdk/pnp/web/wallet-services/usage#swap).
157+
158+
### Transaction Confirmation Screen
152159

153160
You can use the wallet services provider to integrate prebuilt transaction confirmation screens into
154161
your application. Upon successful completion, you can retrieve the signature for the request.

‎docs/sdk/pnp/web/no-modal/initialize.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -172,14 +172,14 @@ const web3auth = new Web3AuthNoModal({
172172

173173
### Whitelabeling
174174

175-
Within the `uiConfig` parameter, you can configure the Web3Auth Modal according to your
175+
Within the `uiConfig` parameter, you can configure the Web3Auth NoModal according to your
176176
application's requirements. It accepts a `WhiteLabelData` object.
177177

178178
:::tip
179179

180180
This is just one of the aspects of whitelabeling you can achieve with Web3Auth. To know more
181181
in-depth about how you can Whitelabel your application with Web3Auth Plug and Play Modal SDK, have a
182-
look at our [Whitelabeling SDK Reference](/sdk/pnp/web/modal/whitelabel).
182+
look at our [Whitelabeling SDK Reference](/sdk/pnp/web/no-modal/whitelabel).
183183

184184
:::
185185

‎src/common/docs/_mfa_minimum_plan.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
:::note
22

3-
This is a paid feature and the minimum [pricing plan](https://web3auth.io/pricing.html) to use this
4-
SDK in a production environment is the **SCALE Plan**. You can use this feature in `sapphire_devnet`
5-
for free.
3+
`mfaSettings` is a paid feature and the minimum [pricing plan](https://web3auth.io/pricing.html) to
4+
use this SDK in a production environment is the **SCALE Plan**. You can use this feature in
5+
`sapphire_devnet` for free.
66

77
:::

‎src/common/sdk/pnp/web/_auth-adapter-intro.mdx‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,8 @@ For customising the MFA settings, you need to pass on `mfaSettings` configuratio
7272

7373
Read more about `mfaSettings` in the [Multi Factor Authentication Section](./mfa) SDK Reference.
7474

75+
**Note: `mfaSettings` is available for SCALE and above plan users.**
76+
7577
:::
7678

7779
```tsx

‎src/common/sdk/pnp/web/_auth-adapter-settings.mdx‎

Lines changed: 9 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -12,25 +12,20 @@ import Tabs from "@theme/Tabs";
1212

1313
| Variable | Description |
1414
| ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
15-
| `clientId` | You can get your clientId/projectId by registering your dapp on [developer dashboard](https://dashboard.web3auth.io) |
16-
| `network` | network specifies the web3auth network to be used. |
17-
| `buildEnv` | This parameter will be used to change the build environment of auth sdk. |
18-
| `redirectUrl` | redirectUrl is the dapp's url where user will be redirected after login. Register this url at [developer dashboard](https://dashboard.web3auth.io) else initialization will give error. |
19-
| `uxMode` | two uxModes are supported:- - `'POPUP'`: In this uxMode, a popup will be shown to user for login. - `'REDIRECT'`: In this uxMode, user will be redirected to a new window tab for login. Use of `'REDIRECT'` mode is recommended in browsers where popups might get blocked. |
15+
| `clientId` | The unique identifier for your application. Obtain this by registering your dapp in the [Web3Auth Dashboard](https://dashboard.web3auth.io) |
16+
| `network` | The Web3Auth network to be used. |
17+
| `buildEnv` | This parameter will be used to change the build environment of auth sdk, mainly for testing purposes. default is `production`. |
18+
| `redirectUrl` | The URL where users will be redirected after login. |
19+
| `uxMode` | Two uxModes supported are:- `'popup'`: In this uxMode, a popup will be shown to user for login. Use `'redirect'`: In this uxMode, user will be redirected to a new window tab for login. Use of `'redirect'` mode is recommended in browsers where popups might get blocked. |
2020
| `replaceUrlOnRedirect` | replaceUrlOnRedirect removes the params from the redirected url after login |
2121
| `originData` | originData is used to verify the origin of dapp by iframe. You don't have to pass originData explicitly if you have registered your dapp at [developer dashboard](https://dashboard.web3auth.io). originData contains a signature of dapp's origin url which is generated using project's secret. |
2222
| `loginConfig` | loginConfig enables you to pass your own login verifiers configuration for various loginProviders. loginConfig is key value map where each key should be a valid loginProvider and value should be custom configuration for that loginProvider. You can deploy your own verifiers from [developer dashboard](https://dashboard.web3auth.io) to use here. |
23-
| `webauthnTransports` | webauthnTransport enables you to configure the transport type user can use for saving their share. This is only available for v1 users. |
24-
| `sdkUrl` | sdkUrl is for internal development use only and is used to override the `network` parameter. |
25-
| `dashboardUrl` | dashboardUrl is for internal development use only and is used to override the `buildEnv` parameter. |
26-
| `whiteLabel` | options for whitelabling default auth modal. |
23+
| `whiteLabel` | options for whitelabling default auth modal screens. |
2724
| `storageServerUrl` | Specify a custom storage server url |
28-
| `storageKey` | setting to "local" will persist social login session across browser tabs. How long should a login session last at a minimum in seconds |
29-
| `sessionTime` | How long should a login session last at a minimum in seconds |
30-
| `sessionNamespace` | This option is for internal use only in torus wallet and has no effect on user's login on other dapps. |
25+
| `storageKey` | setting to "local" will persist social login session across browser tabs. |
26+
| `sessionTime` | This is the sessionTime for the login session |
3127
| `mfaSettings` | This parameter will be used to enable mfa factors and set priority on UI listing. List of factors available `deviceShareFactor` \| `backUpShareFactor` \| `socialBackupFactor` \| `passwordFactor` \| `passkeysFactor` \| `authenticatorFactor` |
32-
| `useMpc` | This parameter will be used to use auth mpc |
33-
| `useCoreKitKey` | This parameter will be used to select core kit key. |
28+
| `useCoreKitKey` | Setting this boolean value to true will get you the core kit key. |
3429

3530
</TabItem>
3631

0 commit comments

Comments
 (0)