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

Improve registerExistingSFAKey docs #1032

Merged
merged 3 commits into from
Jan 9, 2025
Merged

Improve registerExistingSFAKey docs #1032

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8839c76
update docs
AyushBherwani1998 Jan 9, 2025
e2a10ae
fix typo
AyushBherwani1998 Jan 9, 2025
84091b1
Merge branch 'master' into mpc-core-kit-3.4.0
shahbaz17 Jan 9, 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
14 changes: 5 additions & 9 deletions docs/sdk/mpc-core-kit/mpc-core-kit-js/authentication/login-jwt.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ login function.
| `additionalParams?` | Any additional parameter (key-value pair) you'd like to pass to the login function. |
| `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. |
| `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` |
| `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> |
| `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. |

</TabItem>
<TabItem value="type">
Expand Down Expand Up @@ -167,8 +167,8 @@ await coreKitInstance.loginWithJWT(jwtLoginParams);

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

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

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

:::info

Please keep the following points in mind when using this feature:

1. Once the SFA Key is imported, users will no longer be able to access their account through the
SFA SDK.
2. SFA import is available exclusively for Web3Auth SFA v2 users and is not compatible with older
users (v1) of SFA.
Please note, once the SFA Key is imported, users will no longer be able to access their account
through the SFA SDK.

:::

Expand Down
20 changes: 8 additions & 12 deletions docs/sdk/mpc-core-kit/mpc-core-kit-js/authentication/login-oauth.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,10 @@ genetate the same account across both authentication method, you need to use an
The `OAuthLoginParams` has two additional properties which can be used to customize the login flow.
Please check the table below for more details.

| Parameter | Description |
| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `importTssKey?` | The TSS key to import an existing account. |
| `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> |
| Parameter | Description |
| ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `importTssKey?` | The TSS key to import an existing account. |
| `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. |

### SubVerifierDetailsParams

Expand Down Expand Up @@ -220,8 +220,8 @@ await coreKitInstance.loginWithOAuth(verifierConfig);

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

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

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

:::info

Please keep the following points in mind when using this feature:

1. Once the SFA Key is imported, users will no longer be able to access their account through the
SFA SDK.
2. SFA import is available exclusively for Web3Auth SFA v2 users and is not compatible with older
users (v1) of SFA.
Please note, once the SFA Key is imported, users will no longer be able to access their account
through the SFA SDK.

:::

Expand Down
Loading