@web3auth/no-modal 10.0.0-alpha.0 → 10.0.0-alpha.2

package/dist/lib.esm/connectors/auth-connector/authConnector.js

@@ -0,0 +1,501 @@
+import _objectSpread from '@babel/runtime/helpers/objectSpread2';
+import _defineProperty from '@babel/runtime/helpers/defineProperty';
+import { SecurePubSub } from '@toruslabs/secure-pub-sub';
+import { BUILD_ENV, UX_MODE, Auth, SDK_MODE, SUPPORTED_KEY_CURVES, randomId, createHandler, PopupHandler } from '@web3auth/auth';
+import deepmerge from 'deepmerge';
+import { WalletInitializationError, WalletLoginError, Web3AuthError } from '../../base/errors/index.js';
+import { CONNECTOR_NAMESPACES } from '../../base/chain/IChainInterface.js';
+import { BaseConnector } from '../../base/connector/baseConnector.js';
+import { CONNECTOR_CATEGORY, CONNECTOR_STATUS, CONNECTOR_EVENTS } from '../../base/connector/constants.js';
+import 'jwt-decode';
+import { log } from '../../base/loglevel.js';
+import '../../base/plugin/errors.js';
+import '../../base/plugin/IPlugin.js';
+import { cloneDeep, CHAIN_NAMESPACES } from '@toruslabs/base-controllers';
+import '@toruslabs/constants';
+import '@toruslabs/http-helpers';
+import { WALLET_CONNECTORS } from '../../base/wallet/index.js';
+import { getAuthConnectionConfig } from './config/authConnectionConfig.js';
+
+class AuthConnector extends BaseConnector {
+  constructor(params) {
+    super(params);
+    _defineProperty(this, "name", WALLET_CONNECTORS.AUTH);
+    _defineProperty(this, "connectorNamespace", CONNECTOR_NAMESPACES.MULTICHAIN);
+    _defineProperty(this, "type", CONNECTOR_CATEGORY.IN_APP);
+    _defineProperty(this, "authInstance", null);
+    _defineProperty(this, "status", CONNECTOR_STATUS.NOT_READY);
+    _defineProperty(this, "privateKeyProvider", null);
+    _defineProperty(this, "authOptions", void 0);
+    _defineProperty(this, "loginSettings", {
+      authConnection: ""
+    });
+    _defineProperty(this, "wsSettings", void 0);
+    _defineProperty(this, "wsEmbedInstance", null);
+    _defineProperty(this, "authConnectionConfig", []);
+    this.authOptions = params.connectorSettings;
+    this.loginSettings = params.loginSettings || {
+      authConnection: ""
+    };
+    this.wsSettings = params.walletServicesSettings || {};
+    this.authConnectionConfig = params.authConnectionConfig || [];
+  }
+  get provider() {
+    if (this.status !== CONNECTOR_STATUS.NOT_READY) {
+      var _this$wsEmbedInstance;
+      if ((_this$wsEmbedInstance = this.wsEmbedInstance) !== null && _this$wsEmbedInstance !== void 0 && _this$wsEmbedInstance.provider) {
+        return this.wsEmbedInstance.provider;
+      } else if (this.privateKeyProvider) return this.privateKeyProvider;
+    }
+    return null;
+  }
+  get wsEmbed() {
+    return this.wsEmbedInstance;
+  }
+  set provider(_) {
+    throw new Error("Not implemented");
+  }
+  async init(options) {
+    const {
+      chains
+    } = this.coreOptions;
+    const {
+      chainId
+    } = options;
+    const chainConfig = chains.find(x => x.chainId === chainId);
+    super.checkInitializationRequirements({
+      chainConfig
+    });
+    if (!this.coreOptions.clientId) throw WalletInitializationError.invalidParams("clientId is required before auth's initialization");
+    if (!this.authOptions) throw WalletInitializationError.invalidParams("authOptions is required before auth's initialization");
+    const isRedirectResult = this.authOptions.uxMode === UX_MODE.REDIRECT;
+    this.authOptions = _objectSpread(_objectSpread({}, this.authOptions), {}, {
+      replaceUrlOnRedirect: isRedirectResult,
+      useCoreKitKey: this.coreOptions.useCoreKitKey
+    });
+    this.authInstance = new Auth(_objectSpread(_objectSpread({}, this.authOptions), {}, {
+      clientId: this.coreOptions.clientId,
+      network: this.coreOptions.web3AuthNetwork,
+      sdkMode: SDK_MODE.IFRAME,
+      authConnectionConfig: this.authConnectionConfig
+    }));
+    log.debug("initializing auth connector init", this.authOptions);
+    await this.authInstance.init();
+    // Use this for xrpl, mpc cases
+    if (this.coreOptions.privateKeyProvider) {
+      this.privateKeyProvider = this.coreOptions.privateKeyProvider;
+    } else {
+      // initialize ws embed or private key provider based on chain namespace
+      switch (chainConfig.chainNamespace) {
+        case CHAIN_NAMESPACES.EIP155:
+        case CHAIN_NAMESPACES.SOLANA:
+          {
+            const {
+              default: WsEmbed
+            } = await import('@web3auth/ws-embed');
+            this.wsEmbedInstance = new WsEmbed({
+              web3AuthClientId: this.coreOptions.clientId,
+              web3AuthNetwork: this.coreOptions.web3AuthNetwork,
+              modalZIndex: this.wsSettings.modalZIndex
+            });
+            const wsSupportedChains = chains.filter(x => x.chainNamespace === CHAIN_NAMESPACES.EIP155 || x.chainNamespace === CHAIN_NAMESPACES.SOLANA);
+            await this.wsEmbedInstance.init(_objectSpread(_objectSpread({}, this.wsSettings), {}, {
+              chains: wsSupportedChains,
+              chainId,
+              whiteLabel: _objectSpread(_objectSpread({}, this.authOptions.whiteLabel), this.wsSettings.whiteLabel)
+            }));
+            break;
+          }
+        case CHAIN_NAMESPACES.XRPL:
+          throw WalletLoginError.connectionError("Private key provider is required for XRPL");
+        default:
+          {
+            const {
+              CommonPrivateKeyProvider
+            } = await import('../../providers/base-provider/index.js');
+            this.privateKeyProvider = new CommonPrivateKeyProvider({
+              config: {
+                chain: chainConfig,
+                chains: this.coreOptions.chains
+              }
+            });
+          }
+      }
+    }
+    this.status = CONNECTOR_STATUS.READY;
+    this.emit(CONNECTOR_EVENTS.READY, WALLET_CONNECTORS.AUTH);
+    try {
+      log.debug("initializing auth connector");
+      const {
+        sessionId
+      } = this.authInstance || {};
+      // connect only if it is redirect result or if connect (connector is cached/already connected in same session) is true
+      if (sessionId && (options.autoConnect || isRedirectResult)) {
+        this.rehydrated = true;
+        await this.connect({
+          chainId: options.chainId
+        });
+      }
+    } catch (error) {
+      log.error("Failed to connect with cached auth provider", error);
+      this.emit(CONNECTOR_EVENTS.ERRORED, error);
+    }
+  }
+  async connect(params) {
+    super.checkConnectionRequirements();
+    this.status = CONNECTOR_STATUS.CONNECTING;
+    this.emit(CONNECTOR_EVENTS.CONNECTING, _objectSpread(_objectSpread({}, params), {}, {
+      connector: WALLET_CONNECTORS.AUTH
+    }));
+    try {
+      await this.connectWithProvider(params);
+      return this.provider;
+    } catch (error) {
+      var _error$message;
+      log.error("Failed to connect with auth provider", error);
+      // ready again to be connected
+      this.status = CONNECTOR_STATUS.READY;
+      this.emit(CONNECTOR_EVENTS.ERRORED, error);
+      if (error !== null && error !== void 0 && (_error$message = error.message) !== null && _error$message !== void 0 && _error$message.includes("user closed popup")) {
+        throw WalletLoginError.popupClosed();
+      } else if (error instanceof Web3AuthError) {
+        throw error;
+      }
+      throw WalletLoginError.connectionError("Failed to login with auth", error);
+    }
+  }
+  async enableMFA(params = {
+    authConnection: ""
+  }) {
+    if (this.status !== CONNECTOR_STATUS.CONNECTED) throw WalletLoginError.notConnectedError("Not connected with wallet");
+    if (!this.authInstance) throw WalletInitializationError.notReady("authInstance is not ready");
+    try {
+      await this.authInstance.enableMFA(params);
+    } catch (error) {
+      log.error("Failed to enable MFA with auth provider", error);
+      if (error instanceof Web3AuthError) {
+        throw error;
+      }
+      throw WalletLoginError.connectionError("Failed to enable MFA with auth", error);
+    }
+  }
+  async manageMFA(params = {
+    authConnection: ""
+  }) {
+    if (this.status !== CONNECTOR_STATUS.CONNECTED) throw WalletLoginError.notConnectedError("Not connected with wallet");
+    if (!this.authInstance) throw WalletInitializationError.notReady("authInstance is not ready");
+    try {
+      await this.authInstance.manageMFA(params);
+    } catch (error) {
+      log.error("Failed to manage MFA with auth provider", error);
+      if (error instanceof Web3AuthError) {
+        throw error;
+      }
+      throw WalletLoginError.connectionError("Failed to manage MFA with auth", error);
+    }
+  }
+  async disconnect(options = {
+    cleanup: false
+  }) {
+    if (this.status !== CONNECTOR_STATUS.CONNECTED) throw WalletLoginError.notConnectedError("Not connected with wallet");
+    if (!this.authInstance) throw WalletInitializationError.notReady("authInstance is not ready");
+    this.status = CONNECTOR_STATUS.DISCONNECTING;
+    await this.authInstance.logout();
+    if (this.wsEmbedInstance) await this.wsEmbedInstance.logout();
+    if (options.cleanup) {
+      this.status = CONNECTOR_STATUS.NOT_READY;
+      this.authInstance = null;
+      if (this.wsEmbedInstance) this.wsEmbedInstance = null;
+      if (this.privateKeyProvider) this.privateKeyProvider = null;
+    } else {
+      // ready to be connected again
+      this.status = CONNECTOR_STATUS.READY;
+    }
+    this.rehydrated = false;
+    this.emit(CONNECTOR_EVENTS.DISCONNECTED);
+  }
+  async authenticateUser() {
+    if (this.status !== CONNECTOR_STATUS.CONNECTED) throw WalletLoginError.notConnectedError("Not connected with wallet, Please login/connect first");
+    const userInfo = await this.getUserInfo();
+    return {
+      idToken: userInfo.idToken
+    };
+  }
+  async getUserInfo() {
+    if (this.status !== CONNECTOR_STATUS.CONNECTED) throw WalletLoginError.notConnectedError("Not connected with wallet");
+    if (!this.authInstance) throw WalletInitializationError.notReady("authInstance is not ready");
+    const userInfo = this.authInstance.getUserInfo();
+    return userInfo;
+  }
+  // we don't support switching between different namespaces, except for solana and evm
+  async switchChain(params, init = false) {
+    super.checkSwitchChainRequirements(params, init);
+    // get chains and namespaces
+    const {
+      chainId: newChainId
+    } = params;
+    const {
+      chainId: currentChainId
+    } = this.provider;
+    const {
+      chainNamespace: currentNamespace
+    } = this.getChain(currentChainId);
+    const {
+      chainNamespace: newNamespace
+    } = this.getChain(newChainId);
+    // skip if chainId is the same
+    if (currentChainId === newChainId) return;
+    if (currentNamespace === CHAIN_NAMESPACES.SOLANA || currentNamespace === CHAIN_NAMESPACES.EIP155) {
+      var _this$wsEmbedInstance2;
+      // can only switch to solana or evm
+      if (newNamespace !== CHAIN_NAMESPACES.SOLANA && newNamespace !== CHAIN_NAMESPACES.EIP155) throw WalletLoginError.connectionError("Cannot switch to other chain namespace");
+      const fullChainId = `${newNamespace}:${Number(params.chainId)}`;
+      await ((_this$wsEmbedInstance2 = this.wsEmbedInstance.provider) === null || _this$wsEmbedInstance2 === void 0 ? void 0 : _this$wsEmbedInstance2.request({
+        method: "wallet_switchChain",
+        params: {
+          chainId: fullChainId
+        }
+      }));
+    } else {
+      var _this$privateKeyProvi;
+      // cannot switch to other namespaces
+      if (currentNamespace !== newNamespace) throw WalletLoginError.connectionError("Cannot switch to other chain namespace");
+      await ((_this$privateKeyProvi = this.privateKeyProvider) === null || _this$privateKeyProvi === void 0 ? void 0 : _this$privateKeyProvi.switchChain(params));
+    }
+  }
+  getChain(chainId) {
+    return this.coreOptions.chains.find(x => x.chainId === chainId);
+  }
+  _getFinalPrivKey() {
+    if (!this.authInstance) return "";
+    let finalPrivKey = this.authInstance.privKey;
+    // coreKitKey is available only for custom verifiers by default
+    if (this.coreOptions.useCoreKitKey) {
+      // this is to check if the user has already logged in but coreKitKey is not available.
+      // when useCoreKitKey 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();
+      }
+      finalPrivKey = this.authInstance.coreKitKey;
+    }
+    return finalPrivKey;
+  }
+  async connectWithProvider(params) {
+    var _this$authInstance, _params$extraLoginOpt;
+    if (!this.authInstance) throw WalletInitializationError.notReady("authInstance is not ready");
+    const chainConfig = this.coreOptions.chains.find(x => x.chainId === params.chainId);
+    if (!chainConfig) throw WalletLoginError.connectionError("Chain config is not available");
+    const {
+      chainNamespace
+    } = chainConfig;
+    // if not logged in then login
+    const keyAvailable = chainNamespace === CHAIN_NAMESPACES.EIP155 || chainNamespace === CHAIN_NAMESPACES.SOLANA ? (_this$authInstance = this.authInstance) === null || _this$authInstance === void 0 ? void 0 : _this$authInstance.sessionId : this._getFinalPrivKey();
+    if (!keyAvailable || (_params$extraLoginOpt = params.extraLoginOptions) !== null && _params$extraLoginOpt !== void 0 && _params$extraLoginOpt.id_token) {
+      var _params$extraLoginOpt2;
+      // always use "other" curve to return token with all keys encoded so wallet service can switch between evm and solana namespace
+      this.loginSettings.curve = SUPPORTED_KEY_CURVES.OTHER;
+      const loginParams = deepmerge(this.loginSettings, params);
+      if ((_params$extraLoginOpt2 = params.extraLoginOptions) !== null && _params$extraLoginOpt2 !== void 0 && _params$extraLoginOpt2.id_token) {
+        await this.connectWithJwtLogin(loginParams);
+      } else {
+        await this.connectWithSocialLogin(loginParams);
+      }
+    }
+    // setup WS embed if chainNamespace is EIP155 or SOLANA
+    if (chainNamespace === CHAIN_NAMESPACES.EIP155 || chainNamespace === CHAIN_NAMESPACES.SOLANA) {
+      const {
+        sessionId,
+        sessionNamespace
+      } = this.authInstance || {};
+      if (sessionId) {
+        const isLoggedIn = await this.wsEmbedInstance.loginWithSessionId({
+          sessionId,
+          sessionNamespace
+        });
+        if (isLoggedIn) {
+          var _this$wsEmbedInstance3;
+          this.status = CONNECTOR_STATUS.CONNECTED;
+          this.emit(CONNECTOR_EVENTS.CONNECTED, {
+            connector: WALLET_CONNECTORS.AUTH,
+            reconnected: this.rehydrated,
+            provider: this.provider
+          });
+          // handle disconnect from ws embed
+          (_this$wsEmbedInstance3 = this.wsEmbedInstance) === null || _this$wsEmbedInstance3 === void 0 || _this$wsEmbedInstance3.provider.on("accountsChanged", (accounts = []) => {
+            if (accounts.length === 0 && this.status === CONNECTOR_STATUS.CONNECTED) this.disconnect({
+              cleanup: false
+            });
+          });
+        }
+      }
+    } else {
+      // setup private key provider if chainNamespace is other
+      const finalPrivKey = this._getFinalPrivKey();
+      if (finalPrivKey) {
+        await this.privateKeyProvider.setupProvider(finalPrivKey, params.chainId);
+        this.status = CONNECTOR_STATUS.CONNECTED;
+        this.emit(CONNECTOR_EVENTS.CONNECTED, {
+          connector: WALLET_CONNECTORS.AUTH,
+          reconnected: this.rehydrated,
+          provider: this.provider
+        });
+      }
+    }
+  }
+  async connectWithSocialLogin(params) {
+    var _params$extraLoginOpt3, _params$extraLoginOpt4;
+    const providerConfig = this.getOAuthProviderConfig({
+      authConnection: params.authConnection,
+      authConnectionId: params.authConnectionId,
+      groupedAuthConnectionId: params.groupedAuthConnectionId
+    });
+    if (!(providerConfig !== null && providerConfig !== void 0 && providerConfig.authConnection)) throw WalletLoginError.connectionError("Login provider is not available");
+    const jwtParams = _objectSpread(_objectSpread(_objectSpread({}, providerConfig.jwtParameters), params.extraLoginOptions || {}), {}, {
+      login_hint: params.login_hint || ((_params$extraLoginOpt3 = params.extraLoginOptions) === null || _params$extraLoginOpt3 === void 0 ? void 0 : _params$extraLoginOpt3.login_hint)
+    });
+    const nonce = randomId();
+    // post a message to the auth provider to indicate that login has been initiated.
+    const loginParams = cloneDeep(params);
+    loginParams.extraLoginOptions = _objectSpread(_objectSpread({}, loginParams.extraLoginOptions || {}), {}, {
+      login_hint: params.login_hint || ((_params$extraLoginOpt4 = params.extraLoginOptions) === null || _params$extraLoginOpt4 === void 0 ? void 0 : _params$extraLoginOpt4.login_hint)
+    });
+    delete loginParams.chainId;
+    const popupParams = {
+      authConnection: params.authConnection,
+      authConnectionId: providerConfig.authConnectionId,
+      clientId: providerConfig.clientId,
+      groupedAuthConnectionId: providerConfig.groupedAuthConnectionId,
+      redirect_uri: `${this.authInstance.baseUrl}/auth`,
+      jwtParams,
+      customState: {
+        nonce,
+        dapp_redirect_url: this.authOptions.redirectUrl,
+        appState: params.appState,
+        uxMode: this.authOptions.uxMode,
+        whiteLabel: JSON.stringify(this.authOptions.whiteLabel),
+        loginParams: JSON.stringify(loginParams)
+      },
+      web3AuthClientId: this.coreOptions.clientId,
+      web3AuthNetwork: this.coreOptions.web3AuthNetwork
+    };
+    const loginHandler = createHandler(popupParams);
+    const verifierWindow = new PopupHandler({
+      url: loginHandler.finalURL,
+      timeout: 0
+    });
+    if (this.authOptions.uxMode === UX_MODE.REDIRECT) return verifierWindow.redirect(this.authOptions.replaceUrlOnRedirect);
+    let isClosedWindow = false;
+    return new Promise((resolve, reject) => {
+      verifierWindow.open().catch(error => {
+        log.error("Error during login with social", error);
+        this.authInstance.postLoginCancelledMessage(nonce);
+        reject(error);
+      });
+      // this is to close the popup when the login is finished.
+      const securePubSub = new SecurePubSub({
+        sameIpCheck: true
+      });
+      securePubSub.subscribe(`web3auth-login-${nonce}`).then(data => {
+        const parsedData = JSON.parse(data || "{}");
+        if ((parsedData === null || parsedData === void 0 ? void 0 : parsedData.message) === "login_finished") {
+          if (parsedData !== null && parsedData !== void 0 && parsedData.error) {
+            this.authInstance.postLoginCancelledMessage(nonce);
+            reject(parsedData.error);
+          }
+          isClosedWindow = true;
+          securePubSub.cleanup();
+          verifierWindow.close();
+        }
+        return true;
+      }).catch(error => {
+        // swallow the error, dont need to throw.
+        log.error("Error during login with social", error);
+      });
+      verifierWindow.once("close", () => {
+        if (!isClosedWindow) {
+          securePubSub.cleanup();
+          this.authInstance.postLoginCancelledMessage(nonce);
+          reject(WalletLoginError.popupClosed());
+        }
+      });
+      this.authInstance.postLoginInitiatedMessage(loginParams, nonce).then(resolve).catch(reject);
+    });
+  }
+  connectWithJwtLogin(params) {
+    var _params$extraLoginOpt5;
+    const loginConfig = this.getOAuthProviderConfig({
+      authConnection: params.authConnection,
+      authConnectionId: params.authConnectionId,
+      groupedAuthConnectionId: params.groupedAuthConnectionId
+    });
+    if (!(loginConfig !== null && loginConfig !== void 0 && loginConfig.authConnection)) throw WalletLoginError.connectionError("Login provider is not available");
+    const loginParams = cloneDeep(params);
+    loginParams.extraLoginOptions = _objectSpread(_objectSpread({}, loginParams.extraLoginOptions || {}), {}, {
+      login_hint: params.login_hint || ((_params$extraLoginOpt5 = params.extraLoginOptions) === null || _params$extraLoginOpt5 === void 0 ? void 0 : _params$extraLoginOpt5.login_hint)
+    });
+    delete loginParams.chainId;
+    return this.authInstance.postLoginInitiatedMessage(loginParams);
+  }
+  getOAuthProviderConfig(params) {
+    const {
+      authConnection,
+      authConnectionId,
+      groupedAuthConnectionId
+    } = params;
+    const providerConfig = this.authConnectionConfig.find(x => {
+      if (groupedAuthConnectionId) {
+        return x.authConnection === authConnection && x.groupedAuthConnectionId === groupedAuthConnectionId;
+      }
+      if (authConnectionId) {
+        return x.authConnection === authConnection && x.authConnectionId === authConnectionId;
+      }
+      return x.authConnection === authConnection;
+    });
+    return providerConfig;
+  }
+}
+const authConnector = params => {
+  return ({
+    projectConfig,
+    coreOptions
+  }) => {
+    var _coreOptions$uiConfig, _coreOptions$walletSe;
+    // Connector settings
+    const connectorSettings = {};
+    const {
+      whitelist,
+      whitelabel
+    } = projectConfig;
+    if (whitelist) connectorSettings.originData = whitelist.signed_urls;
+    if ((_coreOptions$uiConfig = coreOptions.uiConfig) !== null && _coreOptions$uiConfig !== void 0 && _coreOptions$uiConfig.uxMode) connectorSettings.uxMode = coreOptions.uiConfig.uxMode;
+    const uiConfig = deepmerge(cloneDeep(whitelabel || {}), coreOptions.uiConfig || {});
+    if (!uiConfig.mode) uiConfig.mode = "light";
+    connectorSettings.whiteLabel = uiConfig;
+    const finalConnectorSettings = deepmerge.all([{
+      uxMode: UX_MODE.POPUP,
+      buildEnv: BUILD_ENV.PRODUCTION
+    },
+    // default settings
+    (params === null || params === void 0 ? void 0 : params.connectorSettings) || {}, connectorSettings]);
+    // WS settings
+    const isKeyExportEnabled = typeof projectConfig.key_export_enabled === "boolean" ? projectConfig.key_export_enabled : true;
+    const finalWsSettings = _objectSpread(_objectSpread({}, coreOptions.walletServicesConfig), {}, {
+      whiteLabel: _objectSpread(_objectSpread({}, uiConfig), (_coreOptions$walletSe = coreOptions.walletServicesConfig) === null || _coreOptions$walletSe === void 0 ? void 0 : _coreOptions$walletSe.whiteLabel),
+      accountAbstractionConfig: coreOptions.accountAbstractionConfig,
+      enableLogging: coreOptions.enableLogging
+      // enableKeyExport: keyExportEnabled,
+    });
+    // Core options
+    if (coreOptions.privateKeyProvider) coreOptions.privateKeyProvider.setKeyExportFlag(isKeyExportEnabled);
+    return new AuthConnector({
+      connectorSettings: finalConnectorSettings,
+      walletServicesSettings: finalWsSettings,
+      loginSettings: params === null || params === void 0 ? void 0 : params.loginSettings,
+      coreOptions,
+      authConnectionConfig: getAuthConnectionConfig(finalConnectorSettings.buildEnv, coreOptions.web3AuthNetwork)
+    });
+  };
+};
+
+export { authConnector };