Skip to content

Commit 0401e2a

Browse files
shahbaz17shahbaz17
authored
Merge pull request #1028 from Web3Auth/mpc-core-kit-3.4.0
Update MPC CoreKit Docs
2 parents 2fdda50 + 02a9f26 commit 0401e2a

File tree

3 files changed

+20
-11
lines changed

3 files changed

+20
-11
lines changed

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

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -27,16 +27,17 @@ login function.
2727

2828
<TabItem value="table">
2929

30-
| Parameter | Description |
31-
| ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
32-
| `verifier` | Name of the verifier created on Web3Auth Dashboard. In the case of Aggregate Verifier, the name of the top-level aggregate verifier. |
33-
| `verifierId` | Unique Identifier for the User. The verifier identifier field is set for the verifier/sub verifier. E.g. "sub" field in your JWT ID Token. |
34-
| `idToken` | The idToken received from the Auth Provider. |
35-
| `subVerifier?` | Name of the sub verifier in case of aggregate verifier setup. This field is mandatory in the case of an aggregate verifier. |
36-
| `extraVerifierParams?` | Extra verifier params in case of a WebAuthn verifier type. |
37-
| `additionalParams?` | Any additional parameter (key-value pair) you'd like to pass to the login function. |
38-
| `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. |
39-
| `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` |
30+
| Parameter | Description |
31+
| ------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
32+
| `verifier` | Name of the verifier created on Web3Auth Dashboard. In the case of Aggregate Verifier, the name of the top-level aggregate verifier. |
33+
| `verifierId` | Unique Identifier for the User. The verifier identifier field is set for the verifier/sub verifier. E.g. "sub" field in your JWT ID Token. |
34+
| `idToken` | The idToken received from the Auth Provider. |
35+
| `subVerifier?` | Name of the sub verifier in case of aggregate verifier setup. This field is mandatory in the case of an aggregate verifier. |
36+
| `extraVerifierParams?` | Extra verifier params in case of a WebAuthn verifier type. |
37+
| `additionalParams?` | Any additional parameter (key-value pair) you'd like to pass to the login function. |
38+
| `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. |
39+
| `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> |
4041

4142
</TabItem>
4243
<TabItem value="type">

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

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,14 @@ An aggregate verifier helps to generate a same account across multiple verifiers
3333
verification field. For instance if you are using Google, and Email Passwordless, and want to
3434
genetate the same account across both authentication method, you need to use an aggregate verifier.
3535

36+
The `OAuthLoginParams` has two additional properties which can be used to customize the login flow.
37+
Please check the table below for more details.
38+
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> |
43+
3644
### SubVerifierDetailsParams
3745

3846
Contains the details of the verifier the app needs to use for authentication. You need to use this

‎src/common/versions.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ export const sfaNodeJSVersion = `7.4.x`;
1515
export const tkeyJSVersion = `15.x.x`;
1616
export const tkeyAndroidVersion = `0.0.5`;
1717
export const tkeyIOSVersion = `0.0.4`;
18-
export const mpcCoreKitJSVersion = `3.2.x`;
18+
export const mpcCoreKitJSVersion = `3.4.x`;
1919

2020
import {
2121
web,

0 commit comments

Comments
 (0)