Skip to content

Commit 7ef9268

Browse files
committed
remove all tkey mentions
1 parent 705c794 commit 7ef9268

37 files changed

+34
-2001
lines changed

docs/connect-blockchain/connect-blockchain.mdx

+4-4
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,10 @@ transactions, smart contract wallets, different elliptic curve pairs and even RS
4141

4242
## Private Key Providers (PnP & SFA)
4343

44-
The Private Key Providers work with the majority of Web3Auth products, including Plug and Play SDKs,
45-
Single Factor Auth SDKs, and tKey SSS (v1) SDKs. As the name suggests these providers are a wrapper
46-
around the user's private key, which is dynamically reconstructed with Shamir's Secret Sharing and
47-
is present in the user's frontend.
44+
The Private Key Providers work with the majority of Web3Auth products, including Plug and Play SDKs
45+
and Single Factor Auth SDKs. As the name suggests these providers are a wrapper around the user's
46+
private key, which is dynamically reconstructed with Shamir's Secret Sharing and is present in the
47+
user's frontend.
4848

4949
Once the authentication happens, the returned result from the Web3Auth network is taken up by the
5050
provider to give a common interface to interact with the blockchain of your choice. Currently,

docs/infrastructure/mpc-architecture.mdx

+4-9
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,11 @@ import TkeyMpcFlowDark from "@site/static/images/tkey-mpc-flow-dark.png";
1212
import TkeyMpcFlowLight from "@site/static/images/tkey-mpc-flow-light.png";
1313

1414
This document provides an in-depth exploration of the technical architecture of the MPC-based SDKs,
15-
this includes the tKey MPC SDK and CoreKit MPC SDK (a rundown of our SDKs
16-
[here](/how-web3auth-works/)).
15+
this includes the MPC Core Kit SDKs.
1716

1817
The only difference between the SSS-based SDKs and MPC SDKs are that during usage/login MPC SDKs do
1918
not reconstruct user private keys.
2019

21-
While the tKey MPC SDK, supports multiple configurations like 2/n, 2/2 flows, this documentation,
22-
for simplicity, focuses on a 2/3 setup.
23-
2420
## Overview of Cryptographic and Blockchain Support (compatibility and implementations)
2521

2622
Web3Auth supports most popular blockchains & elliptic curves out there. In particular, out of the
@@ -58,8 +54,8 @@ much more convienent. Notably, but non-exhaustively, Web3Auth supports:
5854

5955
## User Key Overview
6056

61-
Web3Auth uses tKey MPC to manage user wallets in a distributed fashion, leveraging various factors
62-
or shares managed by users, including their devices, private inputs, backup locations, and cloud
57+
Web3Auth uses MPC to manage user wallets in a distributed fashion, leveraging various factors or
58+
shares managed by users, including their devices, private inputs, backup locations, and cloud
6359
service providers. As long as a user can access 2 out of n (2/n) of these shares, they can access
6460
their key. This distributedly secure key is called the $TSSKey$.
6561

@@ -99,8 +95,7 @@ $z_1,z_2 \in \mathbb{Z}_q$.
9995

10096
This key's storage process mirrors that of the TSSKey, with the primary difference being that the
10197
metadataKey is always reconstructed and used for encryption/decryption tasks. It's based on the
102-
fundamental Shamir’s Secret Sharing scheme and initially generated on the user's front-end. Readers
103-
can further reference tKey v1 flows used by the metadataKey in our SSS Infrastructure Documentation.
98+
fundamental Shamir’s Secret Sharing scheme and initially generated on the user's front-end.
10499

105100
## Other components
106101

docs/infrastructure/sss-architecture.mdx

+1-5
Original file line numberDiff line numberDiff line change
@@ -11,17 +11,13 @@ import KeyReconstructionFlow from "@site/static/images/key-reconstruction-sss-fl
1111
import SSSArchitectureFlow from "@site/static/images/sss-architecture-flow.png";
1212

1313
This document provides an in-depth exploration of the technical architecture of the Shamir's Secret
14-
Sharing(SSS)-based SDKs, this includes the current Plug and Play SDKs, tKey SSS SDKs (a rundown of
15-
our SDKs [here](/how-web3auth-works/)).
14+
Sharing(SSS)-based SDKs, this includes the current Plug and Play & Single Factor Auth SDKs.
1615

1716
Shamir's Secret Sharing is a base form of MPC that splits a secret into $n$ shares, of which
1817
threshold $t$ are required to reconstruct the secret. You maybe looking for the
1918
[MPC Architecture documentation](/infrastructure/mpc-architecture/) instead which does not require
2019
the key to be reconstructed on usage.
2120

22-
While the tKey SSS SDK, supports multiple configurations like 2/n, 2/2 flows, or m/n flows, this
23-
documentation, for simplicity, focuses on a 2/3 setup.
24-
2521
## Components
2622

2723
The accompanying image illustrates the typical flow of wallet management within the SSS

docs/product/sfa.mdx

-2
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@ sidebar_label: Single Factor Auth
44
description: "Single Factor Auth | Documentation - Web3Auth"
55
---
66

7-
import TkeyIntroduction from "@site/src/common/docs/_tkey-intro.mdx";
8-
97
import SFAInfraDark from "@site/static/images/sfa-infra-dark.png";
108
import SFAInfraLight from "@site/static/images/sfa-infra-light.png";
119
import { SFACards } from "@site/src/components/SDKReferenceCards";

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ sidebar_label: "Log in with OAuth"
55
description: "Web3Auth MPC Core Kit JS SDK - Log in with OAuth | Documentation - Web3Auth"
66
---
77

8-
import ServiceWorkerCode from "@site/src/common/sdk/infra/tkey/_sw-js.mdx";
8+
import ServiceWorkerCode from "@site/src/common/sdk/mpc-core-kit/_sw-js.mdx";
99

1010
import Tabs from "@theme/Tabs";
1111
import TabItem from "@theme/TabItem";
@@ -271,7 +271,7 @@ DOM with the parameters. These parameters are then used to log in the user with
271271
### Service Worker
272272

273273
A service worker is a script that is run by the browser. It does not have any direct relationship
274-
with the DOM and provides many out-of-the-box network-related features. Web3Auth Core Kit tKey SDK
274+
with the DOM and provides many out-of-the-box network-related features. Web3Auth MPC Core Kit SDK
275275
needs a service worker relative to `baseUrl` to capture the auth redirect at `redirectPathName`
276276
path.
277277

docs/sdk/wallet-services/ChainConfigDropdown.js

-215
This file was deleted.

docs/troubleshooting/different-private-key.mdx

+15-22
Original file line numberDiff line numberDiff line change
@@ -85,14 +85,14 @@ Every product across the Web3Auth Stack has a different set of keys, owing to ho
8585
is set up and how the keys are generated. At large, we can consider 3 different sets of Web3Auth
8686
Products:
8787

88-
- Core Kit: Includes Web3Auth SFA and tKey SDKs. Contain the base key generation logic according to
89-
the verifier selected.
90-
- Plug and Play: Includes the Plug and Play SDKs across various platforms. The keys here are
91-
generated from the Core Kit SDKs, however, the keys are different because of the subkey generation
92-
logic. Keys here change according to the verifier and client ID selected.
93-
- Torus Wallet: It is a wallet built on top of our Core Kit SDK. It has a different set of keys
94-
because it is an application integration Web3Auth and not directly related to any of our
95-
infrastructure offerings.
88+
- Plug and Play SDKs: Includes the Plug and Play SDKs across various platforms. The accounts here
89+
are generated from the Single Factor Auth SDKs, however, the keys are different because of the
90+
subkey generation logic. Keys here change according to the verifier and client ID selected.
91+
92+
- Single Factor Auth SDKs: Contain the base key generation logic according to the verifier selected.
93+
94+
- MPC Core Kit SDKs: Includes the MPC Core Kit SDKs across various platforms. The accounts here are
95+
generated using TSS (Threshold Signature Scheme) and are different from the other products.
9696

9797
### Migrating between SDKs
9898

@@ -107,10 +107,7 @@ account. Please ensure you meet all the requirements for migrating between SDKs.
107107

108108
:::
109109

110-
#### Plug and Play to Core Kit Migration
111-
112-
This is one of the most common migration paths. Usually, developers start with the Web3Auth Plug and
113-
Play for low engineering effort and then transition to Core Kit for a more customized integration.
110+
#### Plug and Play to Single Factor Auth Migration
114111

115112
:::danger
116113

@@ -143,21 +140,17 @@ subkey(PRIVATE_KEY.padStart(64, "0"), Buffer.from(CLIENT_ID, "base64"));
143140

144141
:::info Pre-planning Migrations
145142

146-
Ideally, we would recommend you use the products within the correct configuration to minimize the
147-
migration efforts. Ideally, using the Single Factor Auth SDK beforehand and then shifting to tKey
148-
SDK works best for most integrations, pre-planning your key requirements while using Plug and Play
149-
SDKs can be helpful.
150-
151-
##### If you're looking to use Core Kit SDKs in the future, planning the use Plug and Play SDKs right now, make sure:
143+
If you're looking to use Single Factor Auth SDKs in the future, planning the use Plug and Play SDKs
144+
right now, make sure:
152145

153146
- You're using Custom Authentication with your own login verifiers.
154147
- Set the `useCoreKitKey` flag to `true`
155148

156149
:::
157150

158-
#### Core Kit to Plug and Play Migration
151+
#### Single Factor Auth to Plug and Play Migration
159152

160153
This migration typically occurs when developers want to leverage the prebuilt UI/UX of the Plug and
161-
Play SDKs for user MFA. Use the same verifier details from your Core Kit integration in the custom
162-
authentication feature of Plug and Play. Set the `useCoreKitKey` flag to `true` to use the same
163-
private key as the Core Kit SDKs.
154+
Play SDKs for user MFA. Use the same verifier details from your Single Factor Auth integration in
155+
the custom authentication feature of Plug and Play. Set the `useCoreKitKey` flag to `true` to use
156+
the same private key as the Single Factor Auth SDKs.

docs/troubleshooting/sdk-errors-warnings.mdx

+1-3
Original file line numberDiff line numberDiff line change
@@ -108,9 +108,7 @@ Some other errors could be found during `@web3auth/node-sdk` implementations:
108108
| `Error occurred while verifying params` | Invalid parameter was passed. |
109109
| `Duplicate token found` | An already used (JWT)`id_token` was passed. |
110110

111-
## Web3Auth Core Kit tKey SDK (tKey)
112-
113-
`@tkey/core`
111+
## Web3Auth Infrastructure Errors
114112

115113
| Code | Message |
116114
| ------ | --------------------------------------------------------------------------------------------------------------- |

0 commit comments

Comments
 (0)