@web3auth/modal 7.3.0 → 8.0.0-alpha.0

package/dist/types/modalManager.d.ts

@@ -1,5 +1,5 @@
-import { IProvider, WALLET_ADAPTER_TYPE } from "@web3auth/base";
-import { Web3AuthNoModal, Web3AuthNoModalOptions } from "@web3auth/no-modal";
+import { IProvider, WALLET_ADAPTER_TYPE, Web3AuthNoModalOptions } from "@web3auth/base";
+import { Web3AuthNoModal } from "@web3auth/no-modal";
 import { LoginModal, UIConfig } from "@web3auth/ui";
 import { IWeb3AuthModal, ModalConfig } from "./interface";
 export interface Web3AuthOptions extends Web3AuthNoModalOptions {

package/package.json

@@ -4,27 +4,19 @@
     "url": "https://github.com/Web3Auth/Web3Auth/issues"
   },
   "dependencies": {
-    "@web3auth/base": "^7.2.1",
-    "@web3auth/base-provider": "^7.2.1",
-    "@web3auth/ethereum-provider": "^7.2.1",
-    "@web3auth/metamask-adapter": "^7.2.1",
-    "@web3auth/no-modal": "^7.2.1",
-    "@web3auth/openlogin-adapter": "^7.2.1",
-    "@web3auth/phantom-adapter": "^7.2.1",
-    "@web3auth/solana-provider": "^7.2.1",
-    "@web3auth/torus-evm-adapter": "^7.2.1",
-    "@web3auth/torus-solana-adapter": "^7.2.1",
-    "@web3auth/ui": "^7.2.1",
-    "@web3auth/wallet-connect-v2-adapter": "^7.2.1"
+    "@web3auth/base": "^8.0.0-alpha.0",
+    "@web3auth/base-provider": "^8.0.0-alpha.0",
+    "@web3auth/no-modal": "^8.0.0-alpha.0",
+    "@web3auth/ui": "^8.0.0-alpha.0"
   },
   "devDependencies": {
     "@svgr/webpack": "^8.1.0",
     "@toruslabs/isomorphic-style-loader": "^5.3.3",
-    "@toruslabs/openlogin-utils": "^6.1.0",
-    "css-loader": "^6.8.1",
+    "@toruslabs/openlogin-utils": "^6.2.5",
+    "css-loader": "^6.9.1",
     "postcss-prefix-selector": "^1.16.0",
-    "style-loader": "^3.3.3",
-    "tailwindcss": "^3.4.0",
+    "style-loader": "^3.3.4",
+    "tailwindcss": "^3.4.1",
     "url-loader": "^4.1.1"
   },
   "engines": {
@@ -49,8 +41,7 @@
   "module": "dist/modal.esm.js",
   "name": "@web3auth/modal",
   "peerDependencies": {
-    "@babel/runtime": "7.x",
-    "@solana/web3.js": "^1.x"
+    "@babel/runtime": "7.x"
   },
   "publishConfig": {
     "access": "public"
@@ -70,6 +61,6 @@
   },
   "types": "dist/types/index.d.ts",
   "unpkg": "dist/modal.umd.min.js",
-  "version": "7.3.0",
-  "gitHead": "13816a41cfc89de9c9628fe174cf49c221c1cfda"
+  "version": "8.0.0-alpha.0",
+  "gitHead": "ef1bb1e8518e7c242f5371ea872341eaad755361"
 }

package/src/modalManager.ts

@@ -11,11 +11,14 @@ import {
   LoginMethodConfig,
   WALLET_ADAPTER_TYPE,
   WALLET_ADAPTERS,
+  WalletInitializationError,
+  Web3AuthNoModalOptions,
 } from "@web3auth/base";
 import { CommonJRPCProvider } from "@web3auth/base-provider";
-import { Web3AuthNoModal, Web3AuthNoModalOptions } from "@web3auth/no-modal";
+import { Web3AuthNoModal } from "@web3auth/no-modal";
 import type { OpenloginAdapter } from "@web3auth/openlogin-adapter";
 import { getAdapterSocialLogins, getUserLanguage, LOGIN_MODAL_EVENTS, LoginModal, OPENLOGIN_PROVIDERS, UIConfig } from "@web3auth/ui";
+import type { WalletConnectV2Adapter } from "@web3auth/wallet-connect-v2-adapter";
 
 import {
   defaultEvmDappModalConfig,
@@ -24,7 +27,6 @@ import {
   defaultSolanaDappModalConfig,
   defaultSolanaWalletModalConfig,
 } from "./config";
-import { getDefaultAdapterModule, getPrivateKeyProvider } from "./default";
 import { AdaptersModalConfig, IWeb3AuthModal, ModalConfig } from "./interface";
 
 export interface Web3AuthOptions extends Web3AuthNoModalOptions {
@@ -91,7 +93,7 @@ export class Web3Auth extends Web3AuthNoModal implements IWeb3AuthModal {
     super.checkInitRequirements();
     await this.loginModal.initModal();
     const providedChainConfig = this.options.chainConfig;
-
+    // TODO: get stuff from dashboard here
     // merge default adapters with the custom configured adapters.
     const allAdapters = [...new Set([...Object.keys(this.modalConfig.adapters || {}), ...Object.keys(this.walletAdapters)])];
 
@@ -117,18 +119,8 @@ export class Web3Auth extends Web3AuthNoModal implements IWeb3AuthModal {
       // if adapter is not custom configured then check if it is available in default adapters.
       // and if adapter is not hidden by user
       if (!adapter && this.modalConfig.adapters?.[adapterName].showOnModal) {
-        // if adapter is not configured and some default configuration is available, use it.
-        const ad = await getDefaultAdapterModule({
-          name: adapterName,
-          customChainConfig: this.options.chainConfig,
-          clientId: this.options.clientId,
-          sessionTime: this.options.sessionTime,
-          web3AuthNetwork: this.options.web3AuthNetwork,
-          uiConfig: this.options.uiConfig,
-        });
-
-        this.walletAdapters[adapterName] = ad;
-        return adapterName;
+        // Adapters to be shown on modal should be pre-configured.
+        throw WalletInitializationError.invalidParams(`Adapter ${adapterName} is not configured`);
       } else if (adapter?.type === ADAPTER_CATEGORY.IN_APP || adapter?.type === ADAPTER_CATEGORY.EXTERNAL || adapterName === this.cachedAdapter) {
         if (!this.modalConfig.adapters?.[adapterName].showOnModal) return;
         // add client id to adapter, same web3auth client id can be used in adapter.
@@ -137,6 +129,7 @@ export class Web3Auth extends Web3AuthNoModal implements IWeb3AuthModal {
           clientId: this.options.clientId,
           sessionTime: this.options.sessionTime,
           web3AuthNetwork: this.options.web3AuthNetwork,
+          useCoreKitKey: this.coreOptions.useCoreKitKey,
         });
 
         // if adapter doesn't have any chainConfig then we will set the chainConfig based of passed chainNamespace
@@ -151,10 +144,28 @@ export class Web3Auth extends Web3AuthNoModal implements IWeb3AuthModal {
 
         if (adapterName === WALLET_ADAPTERS.OPENLOGIN) {
           const openloginAdapter = this.walletAdapters[adapterName] as OpenloginAdapter;
+          if (this.coreOptions.privateKeyProvider) {
+            if (openloginAdapter.currentChainNamespace !== this.coreOptions.privateKeyProvider.currentChainConfig.chainNamespace) {
+              throw WalletInitializationError.incompatibleChainNameSpace(
+                "private key provider is not compatible with provided chainNamespace for openlogin adapter"
+              );
+            }
+            openloginAdapter.setAdapterSettings({ privateKeyProvider: this.coreOptions.privateKeyProvider });
+          }
+          openloginAdapter.setAdapterSettings({ whiteLabel: this.options.uiConfig });
           if (!openloginAdapter.privateKeyProvider) {
-            const currentPrivateKeyProvider = await getPrivateKeyProvider(openloginAdapter.chainConfigProxy as CustomChainConfig);
-            openloginAdapter.setAdapterSettings({ privateKeyProvider: currentPrivateKeyProvider, whiteLabel: this.options.uiConfig });
+            throw WalletInitializationError.invalidParams("privateKeyProvider is required for openlogin adapter");
           }
+        } else if (adapterName === WALLET_ADAPTERS.WALLET_CONNECT_V2) {
+          const walletConnectAdapter = this.walletAdapters[adapterName] as WalletConnectV2Adapter;
+          walletConnectAdapter.setAdapterSettings({
+            adapterSettings: {
+              walletConnectInitOptions: {
+                // Using a default wallet connect project id for web3auth modal integration
+                projectId: "d3c63f19f9582f8ba48e982057eb096b", // TODO: get from dashboard
+              },
+            },
+          });
         }
 
         return adapterName;

package/dist/types/default.d.ts

@@ -1,12 +0,0 @@
-import type { OPENLOGIN_NETWORK_TYPE } from "@toruslabs/openlogin-utils";
-import { CustomChainConfig, IAdapter, IBaseProvider, WALLET_ADAPTER_TYPE } from "@web3auth/base";
-import { UIConfig } from "@web3auth/ui";
-export declare function getPrivateKeyProvider(chainConfig: CustomChainConfig): Promise<IBaseProvider<string>>;
-export declare const getDefaultAdapterModule: (params: {
-    name: WALLET_ADAPTER_TYPE;
-    clientId: string;
-    customChainConfig: Partial<CustomChainConfig> & Pick<CustomChainConfig, "chainNamespace">;
-    sessionTime?: number;
-    web3AuthNetwork?: OPENLOGIN_NETWORK_TYPE;
-    uiConfig?: Omit<UIConfig, "adapterListener">;
-}) => Promise<IAdapter<unknown>>;

package/src/default.ts

@@ -1,86 +0,0 @@
-import type { OPENLOGIN_NETWORK_TYPE, OpenLoginOptions } from "@toruslabs/openlogin-utils";
-import { CHAIN_NAMESPACES, CustomChainConfig, getChainConfig, IAdapter, IBaseProvider, WALLET_ADAPTER_TYPE, WALLET_ADAPTERS } from "@web3auth/base";
-import { CommonPrivateKeyProvider } from "@web3auth/base-provider";
-import { UIConfig } from "@web3auth/ui";
-
-export async function getPrivateKeyProvider(chainConfig: CustomChainConfig): Promise<IBaseProvider<string>> {
-  if (chainConfig.chainNamespace === CHAIN_NAMESPACES.SOLANA) {
-    const { SolanaPrivateKeyProvider } = await import("@web3auth/solana-provider");
-    return new SolanaPrivateKeyProvider({ config: { chainConfig } });
-  } else if (chainConfig.chainNamespace === CHAIN_NAMESPACES.EIP155) {
-    const { EthereumPrivateKeyProvider } = await import("@web3auth/ethereum-provider");
-    return new EthereumPrivateKeyProvider({ config: { chainConfig } });
-  } else if (chainConfig.chainNamespace === CHAIN_NAMESPACES.OTHER) {
-    // Modal doesn't support ripple provider
-    // Can always override this with a custom provider
-    return new CommonPrivateKeyProvider({ config: { chainConfig } });
-  }
-  throw new Error(`Invalid chainNamespace: ${chainConfig.chainNamespace} found while connecting to wallet`);
-}
-
-// warning: this function is not compatible with "OTHER" chain namespace.
-export const getDefaultAdapterModule = async (params: {
-  name: WALLET_ADAPTER_TYPE;
-  clientId: string;
-  customChainConfig: Partial<CustomChainConfig> & Pick<CustomChainConfig, "chainNamespace">;
-  sessionTime?: number;
-  web3AuthNetwork?: OPENLOGIN_NETWORK_TYPE;
-  uiConfig?: Omit<UIConfig, "adapterListener">;
-}): Promise<IAdapter<unknown>> => {
-  const { name, customChainConfig, clientId, sessionTime, web3AuthNetwork, uiConfig } = params;
-  if (!Object.values(CHAIN_NAMESPACES).includes(customChainConfig.chainNamespace))
-    throw new Error(`Invalid chainNamespace: ${customChainConfig.chainNamespace}`);
-  const finalChainConfig = {
-    ...(getChainConfig(customChainConfig.chainNamespace, customChainConfig?.chainId) as CustomChainConfig),
-    ...(customChainConfig || {}),
-  };
-  if (name === WALLET_ADAPTERS.TORUS_EVM) {
-    const { TorusWalletAdapter } = await import("@web3auth/torus-evm-adapter");
-    const adapter = new TorusWalletAdapter({ chainConfig: finalChainConfig, clientId, sessionTime, web3AuthNetwork });
-    return adapter;
-  } else if (name === WALLET_ADAPTERS.TORUS_SOLANA) {
-    const { SolanaWalletAdapter } = await import("@web3auth/torus-solana-adapter");
-    const adapter = new SolanaWalletAdapter({ chainConfig: finalChainConfig, clientId, sessionTime, web3AuthNetwork });
-    return adapter;
-  } else if (name === WALLET_ADAPTERS.METAMASK) {
-    const { MetamaskAdapter } = await import("@web3auth/metamask-adapter");
-    const adapter = new MetamaskAdapter({ chainConfig: finalChainConfig, clientId, sessionTime, web3AuthNetwork });
-    return adapter;
-  } else if (name === WALLET_ADAPTERS.PHANTOM) {
-    const { PhantomAdapter } = await import("@web3auth/phantom-adapter");
-    const adapter = new PhantomAdapter({ chainConfig: finalChainConfig, clientId, sessionTime, web3AuthNetwork });
-    return adapter;
-  } else if (name === WALLET_ADAPTERS.WALLET_CONNECT_V2) {
-    const { WalletConnectV2Adapter } = await import("@web3auth/wallet-connect-v2-adapter");
-    const adapter = new WalletConnectV2Adapter({
-      chainConfig: finalChainConfig,
-      clientId,
-      sessionTime,
-      web3AuthNetwork,
-      adapterSettings: {
-        walletConnectInitOptions: {
-          // Using a default wallet connect project id for web3auth modal integration
-          projectId: "d3c63f19f9582f8ba48e982057eb096b",
-        },
-      },
-    });
-    return adapter;
-  } else if (name === WALLET_ADAPTERS.OPENLOGIN) {
-    const { OpenloginAdapter, getOpenloginDefaultOptions } = await import("@web3auth/openlogin-adapter");
-
-    const privateKeyProvider: IBaseProvider<string> = await getPrivateKeyProvider(finalChainConfig);
-
-    const defaultOptions = getOpenloginDefaultOptions();
-    const adapter = new OpenloginAdapter({
-      ...defaultOptions,
-      clientId,
-      chainConfig: { ...finalChainConfig },
-      adapterSettings: { ...(defaultOptions.adapterSettings as OpenLoginOptions), clientId, network: web3AuthNetwork, whiteLabel: uiConfig },
-      sessionTime,
-      web3AuthNetwork,
-      privateKeyProvider,
-    });
-    return adapter;
-  }
-  throw new Error("Invalid wallet adapter name");
-};