Skip to content

feat: split login flow to login and setup #142

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

Draft
ieow wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

feat: split login flow to login and setup #142

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
69bcdf1
feat: initial implementation
ieow May 7, 2024
5e6f0a9
fix: missing await
ieow May 7, 2024
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
11 changes: 9 additions & 2 deletions src/interfaces.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,10 @@ export interface IFactorKey {
export enum COREKIT_STATUS {
NOT_INITIALIZED = "NOT_INITIALIZED",
INITIALIZED = "INITIALIZED",
// after oauth/jwt login
NEW_USER = "NEW_USER",
EXISTING_USER = "EXISTING_USER",
// after setup
REQUIRED_SHARE = "REQUIRED_SHARE",
LOGGED_IN = "LOGGED_IN",
}
Expand Down Expand Up @@ -191,14 +195,17 @@ export interface ICoreKit {
/**
* Login into the SDK in an implicit flow and initialize all relevant components.
* @param loginParams - Parameters for Implicit Login.
* @param opt.manualSetup - Manual Setup - break login to 2 steps flow. Default is false.
*/
loginWithOauth(loginParams: OauthLoginParams): Promise<void>;
loginWithOauth(loginParams: OauthLoginParams, opt: { manualSetup?: boolean }): Promise<void>;

/**
* Login into the SDK using ID Token based login and initialize all relevant components.
* @param idTokenLoginParams - Parameters with ID Token based Login.
* @param opt.prefetchTssPublicKeys - Prefetch DKG TSS Public Keys. Default is 1.
* @param opt.manualSetup - Manual Setup - break login to 2 steps flow. Default is false.
*/
loginWithJWT(idTokenLoginParams: IdTokenLoginParams): Promise<void>;
loginWithJWT(idTokenLoginParams: IdTokenLoginParams, opt: { prefetchTssPublicKeys: number; manualSetup?: boolean }): Promise<void>;

/**
* Enable MFA for the user. Deletes the Cloud factor and generates a new
Expand Down
57 changes: 48 additions & 9 deletions src/mpcCoreKit.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,8 @@ export class Web3AuthMPCCoreKit implements ICoreKit {

private ready = false;

private newUser?: boolean = undefined;

constructor(options: Web3AuthOptions) {
if (!options.chainConfig) options.chainConfig = DEFAULT_CHAIN_CONFIG;
if (options.chainConfig.chainNamespace !== CHAIN_NAMESPACES.EIP155) {
Expand Down Expand Up @@ -188,7 +190,15 @@ export class Web3AuthMPCCoreKit implements ICoreKit {
// if 2 shares are present, then privKey will be present after metadatakey(tkey) reconstruction
const { tkey } = this;
if (!tkey) return COREKIT_STATUS.NOT_INITIALIZED;
if (!tkey.metadata) return COREKIT_STATUS.INITIALIZED;
if (!tkey.metadata) {
if (this.newUser === undefined) {
return COREKIT_STATUS.INITIALIZED;
}
if (this.newUser) {
return COREKIT_STATUS.NEW_USER;
}
return COREKIT_STATUS.EXISTING_USER;
}
if (!tkey.privKey || !this.state.factorKey) return COREKIT_STATUS.REQUIRED_SHARE;
return COREKIT_STATUS.LOGGED_IN;
} catch (e) {}
Expand Down Expand Up @@ -329,7 +339,12 @@ export class Web3AuthMPCCoreKit implements ICoreKit {
// if not redirect flow or session rehydration, ask for factor key to login
}

public async loginWithOauth(params: OauthLoginParams): Promise<void> {
public async loginWithOauth(
params: OauthLoginParams,
opt: { manualSetup?: boolean } = {
manualSetup: false,
}
): Promise<void> {
this.checkReady();
if (this.isNodejsOrRN(this.options.uxMode)) {
throw CoreKitError.oauthLoginUnsupported(`Oauth login is NOT supported in ${this.options.uxMode} mode.`);
Expand Down Expand Up @@ -368,7 +383,16 @@ export class Web3AuthMPCCoreKit implements ICoreKit {
});
}

await this.setupTkey(importTssKey);
if (await this.isMetadataPresent(this.state.oAuthKey)) {
this.newUser = false;
} else {
this.newUser = true;
}

// default manualSetup is false
if (!opt.manualSetup) {
await this.setupKey(importTssKey);
}
} catch (err: unknown) {
log.error("login error", err);
if (err instanceof CoreError) {
Expand All @@ -389,7 +413,7 @@ export class Web3AuthMPCCoreKit implements ICoreKit {
*/
public async loginWithJWT(
idTokenLoginParams: IdTokenLoginParams,
opt: { prefetchTssPublicKeys: number } = { prefetchTssPublicKeys: 1 }
opt: { prefetchTssPublicKeys: number; manualSetup?: boolean } = { prefetchTssPublicKeys: 1, manualSetup: false }
): Promise<void> {
this.checkReady();
if (opt.prefetchTssPublicKeys > 3) {
Expand Down Expand Up @@ -444,7 +468,16 @@ export class Web3AuthMPCCoreKit implements ICoreKit {
// wait for prefetch completed before setup tkey
await Promise.all(prefetchTssPubs);

await this.setupTkey(importTssKey);
if (await this.isMetadataPresent(this.state.oAuthKey)) {
this.newUser = false;
} else {
this.newUser = true;
}

// default manualSetup is false
if (!opt.manualSetup) {
await this.setupKey(importTssKey);
}
} catch (err: unknown) {
log.error("login error", err);
if (err instanceof CoreError) {
Expand Down Expand Up @@ -498,7 +531,7 @@ export class Web3AuthMPCCoreKit implements ICoreKit {
}
this.torusSp.postboxKey = new BN(this.state.oAuthKey, "hex");
this.torusSp.verifierId = userInfo.verifierId;
await this.setupTkey();
await this.setupKey();
} catch (error: unknown) {
this.resetState();
log.error("error while handling redirect result", error);
Expand Down Expand Up @@ -961,12 +994,17 @@ export class Web3AuthMPCCoreKit implements ICoreKit {
return tssNonce;
}

private async setupTkey(importTssKey?: string): Promise<void> {
public async setupKey(importTssKey?: string): Promise<void> {
if (!this.state.oAuthKey) {
throw CoreKitError.userNotLoggedIn();
}
const existingUser = await this.isMetadataPresent(this.state.oAuthKey);
if (!existingUser) {
if (this.tkey.privKey) {
throw CoreKitError.default("CoreKit already setup, Please logout and reinitialize again.");
}
if (this.newUser === undefined) {
throw CoreError.default("Invalid login, Please reinitalize again");
}
if (this.newUser) {
await this.handleNewUser(importTssKey);
} else {
if (importTssKey) {
Expand Down Expand Up @@ -1297,6 +1335,7 @@ export class Web3AuthMPCCoreKit implements ICoreKit {
this.torusSp = null;
this.storageLayer = null;
this.providerProxy = null;
this.newUser = undefined;
}

private _getOAuthKey(result: TorusKey): string {
Expand Down