rename web3auth options

Author: arch1995

demo/vue-app-new/src/MainView.vue

@@ -127,7 +127,7 @@ const options = computed((): Web3AuthOptions => {
     // enableLogging?: boolean;
     // storageType?: "session" | "local";
     // sessionTime?: number;
-    // useCoreKitKey?: boolean;
+    // useSFAKey?: boolean;
     chains,
     defaultChainId: formData.defaultChainId,
     enableLogging: true,

packages/no-modal/src/base/core/IWeb3Auth.ts

@@ -1,5 +1,5 @@
 import { type AccountAbstractionMultiChainConfig } from "@toruslabs/ethereum-controllers";
-import { type BUILD_ENV_TYPE, type LoginParams, SafeEventEmitter, UX_MODE_TYPE, type WhiteLabelData } from "@web3auth/auth";
+import { type BUILD_ENV_TYPE, type LoginParams, MfaSettings, SafeEventEmitter, UX_MODE_TYPE, type WhiteLabelData } from "@web3auth/auth";
 import { type WsEmbedParams } from "@web3auth/ws-embed";
 
 import { type ChainNamespaceType, type CustomChainConfig } from "../chain/IChainInterface";
@@ -91,17 +91,17 @@ export interface IWeb3AuthCoreOptions {
    * Note: max value can be 30 days (86400 * 30) and min can be  1 sec (1)
    */
   sessionTime?: number;
+
   /**
-   * Web3Auth Network to use for the session & the issued idToken
-   * @defaultValue sapphire_mainnet
+   * Web3Auth Network to use for the session.
    */
-  web3AuthNetwork?: WEB3AUTH_NETWORK_TYPE;
+  web3AuthNetwork: WEB3AUTH_NETWORK_TYPE;
 
   /**
    * Uses core-kit key with web3auth provider
    * @defaultValue false
    */
-  useCoreKitKey?: boolean;
+  useSFAKey?: boolean;
 
   /**
    * WhiteLabel options for web3auth
@@ -157,6 +157,11 @@ export interface IWeb3AuthCoreOptions {
    * @defaultValue BUILD_ENV.PRODUCTION
    */
   authBuildEnv?: BUILD_ENV_TYPE;
+
+  /**
+   * MFA settings for the auth connector
+   */
+  mfaSettings?: MfaSettings;
 }
 
 export type LoginParamMap = {

packages/no-modal/src/base/errors/index.ts

@@ -137,7 +137,7 @@ export class WalletLoginError extends Web3AuthError {
     5115: "User has already enabled mfa, please use the @web3auth/web3auth-web sdk for login with mfa",
     5116: "Chain config has not been added. Please add the chain config before calling switchChain",
     5117: "Unsupported operation",
-    5118: "useCoreKitKey flag is enabled but coreKitKey is not available",
+    5118: "useSFAKey flag is enabled but SFA key is not available",
     5119: "User not logged in.",
   };
 
@@ -181,7 +181,7 @@ export class WalletLoginError extends Web3AuthError {
     return WalletLoginError.fromCode(5117, extraMessage, cause);
   }
 
-  public static coreKitKeyNotFound(extraMessage = "", cause?: unknown): IWeb3AuthError {
+  public static sfaKeyNotFound(extraMessage = "", cause?: unknown): IWeb3AuthError {
     return WalletLoginError.fromCode(5118, extraMessage, cause);
   }
 

packages/no-modal/src/connectors/auth-connector/authConnector.ts

@@ -111,7 +111,7 @@ class AuthConnector extends BaseConnector<AuthLoginParams> {
       throw WalletInitializationError.invalidParams("authConnectionConfig is required before auth's initialization");
     const isRedirectResult = this.authOptions.uxMode === UX_MODE.REDIRECT;
 
-    this.authOptions = { ...this.authOptions, replaceUrlOnRedirect: isRedirectResult, useCoreKitKey: this.coreOptions.useCoreKitKey };
+    this.authOptions = { ...this.authOptions, replaceUrlOnRedirect: isRedirectResult, useCoreKitKey: this.coreOptions.useSFAKey };
     this.authInstance = new Auth({
       ...this.authOptions,
       clientId: this.coreOptions.clientId,
@@ -320,13 +320,13 @@ class AuthConnector extends BaseConnector<AuthLoginParams> {
   private _getFinalPrivKey() {
     if (!this.authInstance) return "";
     let finalPrivKey = this.authInstance.privKey;
-    // coreKitKey is available only for custom verifiers by default
-    if (this.coreOptions.useCoreKitKey) {
+    // coreKitKey is available only for custom connections by default
+    if (this.coreOptions.useSFAKey) {
       // this is to check if the user has already logged in but coreKitKey is not available.
-      // when useCoreKitKey is set to true.
+      // when useSFAKey is set to true.
       // This is to ensure that when there is no user session active, we don't throw an exception.
       if (this.authInstance.privKey && !this.authInstance.coreKitKey) {
-        throw WalletLoginError.coreKitKeyNotFound();
+        throw WalletLoginError.sfaKeyNotFound();
       }
       finalPrivKey = this.authInstance.coreKitKey;
     }
@@ -642,8 +642,8 @@ export const authConnector = (params?: AuthConnectorFuncParams): ConnectorFn =>
       walletServicesSettings: finalWsSettings,
       loginSettings: params?.loginSettings,
       coreOptions,
-      // TODO: check, test this and may need to send modal config here later on.!!
       authConnectionConfig: projectConfig.embeddedWalletAuth,
+      mfaSettings: coreOptions.mfaSettings,
     });
   };
 };

packages/no-modal/src/connectors/auth-connector/interface.ts

@@ -1,4 +1,4 @@
-import { type AuthConnectionConfigItem, type AuthOptions, type LoginParams } from "@web3auth/auth";
+import { type AuthConnectionConfigItem, type AuthOptions, type LoginParams, MfaSettings } from "@web3auth/auth";
 import { type WsEmbedParams } from "@web3auth/ws-embed";
 
 import { type BaseConnectorSettings, type IBaseProvider } from "../../base";
@@ -10,10 +10,11 @@ export type PrivateKeyProvider = IBaseProvider<string>;
 export type WalletServicesSettings = Omit<WsEmbedParams, "chains" | "chainId"> & { modalZIndex?: number };
 
 export interface AuthConnectorOptions extends BaseConnectorSettings {
-  connectorSettings?: Omit<AuthOptions, "clientId" | "network" | "authConnectionConfig">;
+  connectorSettings?: Omit<AuthOptions, "clientId" | "network" | "authConnectionConfig" | "mfaSettings">;
   loginSettings?: LoginSettings;
   walletServicesSettings?: WalletServicesSettings;
   authConnectionConfig?: (AuthConnectionConfigItem & { isDefault?: boolean })[];
+  mfaSettings?: MfaSettings;
 }
 
 export {