Skip to content

Commit ca95444

Browse files
AyushBherwani1998AyushBherwani1998
authored
Merge pull request #1032 from Web3Auth/mpc-core-kit-3.4.0
Improve registerExistingSFAKey docs
2 parents bcdc94d + 84091b1 commit ca95444

File tree

2 files changed

+13
-21
lines changed

2 files changed

+13
-21
lines changed

‎docs/sdk/mpc-core-kit/mpc-core-kit-js/authentication/login-jwt.mdx‎

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ login function.
3737
| `additionalParams?` | Any additional parameter (key-value pair) you'd like to pass to the login function. |
3838
| `importTssKey?` | Key to import key into TSS during first time login. For secp256k1 curve, you need to pass the private key, and for ed25519 curve you need to pass the seed. The ed25519 seed is hashed to generate 64 bytes, where first 32 bytes are used to generate the public key, and last 32 bytes are used as private key. |
3939
| `prefetchTssPublicKeys?` | Defines the number of TSS public keys to prefetch.The SDK by default starts with 2/2 flow, and this parameter should be used in the flow where you want to generate the recovery factor during first time login. The parameters helps you to reduce the operation time by pre-fetching the TSS public key and use it during generating new shares. For existing user you can set it to `0`. Default is `1`, maximum is `3` |
40-
| `registerExistingSFAKey?` | Allows to import the Single Factor Auth(SFA) Key into the MPC Core Kit SDK. Default value is `false`. Please note: <ul><li>Once SFA Key is imported, users won't be able to access their account using the SFA SDK.</li><li>SFA import can only be done for the Web3Auth SFA v2 users, and doesn't work for old(v1) users of SFA.</li></ul> |
40+
| `registerExistingSFAKey?` | Allows to import the [Single Factor Auth(SFA) SDK](/docs/sdk/sfa/sfa-js/) key into the MPC Core Kit SDK. Default value is `false`. Please note, once SFA Key is imported, users won't be able to access their account using the SFA SDK. |
4141

4242
</TabItem>
4343
<TabItem value="type">
@@ -167,8 +167,8 @@ await coreKitInstance.loginWithJWT(jwtLoginParams);
167167

168168
## Importing an existing Single Factor Auth(SFA) Key.
169169

170-
When logging in for the first time, you can import an existing SFA key using the
171-
`registerExistingSFAKey` parameter. By default, the value of this parameter is `false`.
170+
When logging in for the first time, you can import an existing [SFA SDK](/docs/sdk/sfa/sfa-js/) key
171+
using the `registerExistingSFAKey` parameter. By default, the value of this parameter is `false`.
172172

173173
Additionally, this parameter allows you to leverage the
174174
[wallet pregeneration API](/docs/features/wallet-pregeneration) to pre-generate a wallet address.
@@ -180,12 +180,8 @@ SDK/ Wallet Pregeneration API and MPC Core Kit SDK.
180180

181181
:::info
182182

183-
Please keep the following points in mind when using this feature:
184-
185-
1. Once the SFA Key is imported, users will no longer be able to access their account through the
186-
SFA SDK.
187-
2. SFA import is available exclusively for Web3Auth SFA v2 users and is not compatible with older
188-
users (v1) of SFA.
183+
Please note, once the SFA Key is imported, users will no longer be able to access their account
184+
through the SFA SDK.
189185

190186
:::
191187

‎docs/sdk/mpc-core-kit/mpc-core-kit-js/authentication/login-oauth.mdx‎

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,10 @@ genetate the same account across both authentication method, you need to use an
3636
The `OAuthLoginParams` has two additional properties which can be used to customize the login flow.
3737
Please check the table below for more details.
3838

39-
| Parameter | Description |
40-
| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
41-
| `importTssKey?` | The TSS key to import an existing account. |
42-
| `registerExistingSFAKey?` | Allows to import the Single Factor Auth(SFA) Key into the MPC Core Kit SDK. Default value is `false`. Please note: <ul><li>Once SFA Key is imported, users won't be able to access their account using the SFA SDK.</li><li>SFA import can only be done for the Web3Auth SFA v2 users, and doesn't work for old(v1) users of SFA.</li></ul> |
39+
| Parameter | Description |
40+
| ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
41+
| `importTssKey?` | The TSS key to import an existing account. |
42+
| `registerExistingSFAKey?` | Allows to import the [Single Factor Auth(SFA) SDK](/docs/sdk/sfa/sfa-js/) key into the MPC Core Kit SDK. Default value is `false`. Please note, once SFA Key is imported, users won't be able to access their account using the SFA SDK. |
4343

4444
### SubVerifierDetailsParams
4545

@@ -220,8 +220,8 @@ await coreKitInstance.loginWithOAuth(verifierConfig);
220220

221221
## Importing an existing Single Factor Auth(SFA) Key.
222222

223-
When logging in for the first time, you can import an existing SFA key using the
224-
`registerExistingSFAKey` parameter. By default, the value of this parameter is `false`.
223+
When logging in for the first time, you can import an existing [SFA SDK](/docs/sdk/sfa/sfa-js/) key
224+
using the `registerExistingSFAKey` parameter. By default, the value of this parameter is `false`.
225225

226226
Additionally, this parameter allows you to leverage the
227227
[wallet pregeneration API](/docs/features/wallet-pregeneration) to pre-generate a wallet address.
@@ -233,12 +233,8 @@ SDK/ Wallet Pregeneration API and MPC Core Kit SDK.
233233

234234
:::info
235235

236-
Please keep the following points in mind when using this feature:
237-
238-
1. Once the SFA Key is imported, users will no longer be able to access their account through the
239-
SFA SDK.
240-
2. SFA import is available exclusively for Web3Auth SFA v2 users and is not compatible with older
241-
users (v1) of SFA.
236+
Please note, once the SFA Key is imported, users will no longer be able to access their account
237+
through the SFA SDK.
242238

243239
:::
244240

0 commit comments

Comments
 (0)