refactor project config interface

Author: tanguyenvn

packages/no-modal/src/base/connector/constants.ts

@@ -19,3 +19,8 @@ export const CONNECTOR_CATEGORY = {
   EXTERNAL: "external",
   IN_APP: "in_app",
 } as const;
+
+export const SMART_ACCOUNT_WALLET_SCOPE = {
+  EMBEDDED: "embedded",
+  ALL: "all",
+} as const;

packages/no-modal/src/base/interfaces.ts

@@ -3,76 +3,60 @@ import { type SmartAccountType } from "@toruslabs/ethereum-controllers";
 import { type AuthConnectionConfig, type WhiteLabelData } from "@web3auth/auth";
 
 import { type ChainNamespaceType, type CustomChainConfig } from "./chain/IChainInterface";
+import { SMART_ACCOUNT_WALLET_SCOPE } from "./connector";
 
 export interface WhitelistResponse {
   urls: string[];
   signed_urls: Record<string, string>;
 }
 
-export type ChainsConfig = {
-  chainId: string;
-  enabled: boolean;
-  config: CustomChainConfig;
-}[];
+export type ChainsConfig = CustomChainConfig[];
 
 export interface ExternalWalletsConfig {
-  enabled: boolean;
-  config: { wallet: string; enabled: boolean }[];
+  disableAllRecommendedWallets?: boolean;
+  disableAllOtherWallets?: boolean;
+  disabledWallets?: string[];
 }
 
-export const SMART_ACCOUNT_WALLET_SCOPE = {
-  EMBEDDED_ONLY: "embeddedOnly",
-  ALL: "all",
-} as const;
-
 export type SmartAccountWalletScope = (typeof SMART_ACCOUNT_WALLET_SCOPE)[keyof typeof SMART_ACCOUNT_WALLET_SCOPE];
 
 export interface SmartAccountsConfig {
-  enabled: boolean;
-  config: {
-    smartAccountType: SmartAccountType;
-    walletScope: SmartAccountWalletScope;
-    chains: {
-      chainId: string;
-      bundlerConfig: {
-        url: string;
-      };
-      paymasterConfig?: {
-        url: string;
-      };
-    }[];
-  };
+  smartAccountType: SmartAccountType;
+  walletScope: SmartAccountWalletScope;
+  chains: {
+    chainId: string;
+    bundlerConfig: {
+      url: string;
+    };
+    paymasterConfig?: {
+      url: string;
+    };
+  }[];
 }
 
 export interface WalletUiConfig {
-  portfolioWidgetEnabled: boolean;
-  portfolioWidgetPosition: BUTTON_POSITION_TYPE;
-  confirmationModalEnabled: boolean;
-  walletConnectEnabled: boolean;
-  tokenDisplayEnabled: boolean;
-  nftDisplayEnabled: boolean;
-  defaultPortfolio: "token" | "nft";
-  showAllTokensButtonEnabled: boolean;
-  buyButtonEnabled: boolean;
-  sendButtonEnabled: boolean;
-  swapButtonEnabled: boolean;
-  receiveButtonEnabled: boolean;
+  enablePortfolioWidget?: boolean;
+  enableConfirmationModal?: boolean;
+  enableWalletConnect?: boolean;
+  enableTokenDisplay?: boolean;
+  enableNftDisplay?: boolean;
+  enableShowAllTokensButton?: boolean;
+  enableBuyButton?: boolean;
+  enableSendButton?: boolean;
+  enableSwapButton?: boolean;
+  enableReceiveButton?: boolean;
+  portfolioWidgetPosition?: BUTTON_POSITION_TYPE;
+  defaultPortfolio?: "token" | "nft";
 }
 
 // TODO: finalize the project config
 export interface ProjectConfig {
   // Legacy
   sms_otp_enabled: boolean;
-  /** @deprecated If external_wallets.enabled is true, WC will be enabled automatically */
-  wallet_connect_enabled: boolean;
-  /** @deprecated always use Web3Auth WalletConnect project ID */
-  wallet_connect_project_id?: string;
-  /** @deprecated use keyExportEnabled */
-  key_export_enabled?: boolean;
   // Project settings
   userDataIncludedInToken?: boolean; // TODO: implement this
   sessionTime?: number;
-  keyExportEnabled?: boolean;
+  enableKeyExport?: boolean;
   whitelist?: WhitelistResponse; // remain unchanged
   whitelabel?: WhiteLabelData; // remain unchanged
   // Chains

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

@@ -523,46 +523,46 @@ export const authConnector = (params?: Omit<AuthConnectorOptions, "coreOptions"
     ]) as AuthConnectorOptions["connectorSettings"];
 
     // WS settings
-    const { keyExportEnabled, walletUi } = projectConfig;
-    const isKeyExportEnabled = typeof keyExportEnabled === "boolean" ? keyExportEnabled : true;
+    const { enableKeyExport, walletUi } = projectConfig;
+    const isKeyExportEnabled = typeof enableKeyExport === "boolean" ? enableKeyExport : true;
     const {
-      portfolioWidgetEnabled = false,
+      enablePortfolioWidget = false,
+      enableTokenDisplay = true,
+      enableNftDisplay = true,
+      enableWalletConnect = true,
+      enableBuyButton = true,
+      enableSendButton = true,
+      enableSwapButton = true,
+      enableReceiveButton = true,
+      enableShowAllTokensButton = true,
+      enableConfirmationModal = false,
       portfolioWidgetPosition = BUTTON_POSITION.BOTTOM_LEFT,
       defaultPortfolio = "token",
-      tokenDisplayEnabled = true,
-      nftDisplayEnabled = true,
-      walletConnectEnabled = true,
-      buyButtonEnabled = true,
-      sendButtonEnabled = true,
-      swapButtonEnabled = true,
-      receiveButtonEnabled = true,
-      showAllTokensButtonEnabled = true,
-      confirmationModalEnabled = false,
     } = walletUi || {};
     const projectConfigWhiteLabel: WalletServicesSettings["whiteLabel"] = {
-      showWidgetButton: portfolioWidgetEnabled,
-      hideNftDisplay: !nftDisplayEnabled,
-      hideTokenDisplay: !tokenDisplayEnabled,
-      hideTransfers: !sendButtonEnabled,
-      hideTopup: !buyButtonEnabled,
-      hideReceive: !receiveButtonEnabled,
-      hideSwap: !swapButtonEnabled,
-      hideShowAllTokens: !showAllTokensButtonEnabled,
-      hideWalletConnect: !walletConnectEnabled,
+      showWidgetButton: enablePortfolioWidget,
+      hideNftDisplay: !enableNftDisplay,
+      hideTokenDisplay: !enableTokenDisplay,
+      hideTransfers: !enableSendButton,
+      hideTopup: !enableBuyButton,
+      hideReceive: !enableReceiveButton,
+      hideSwap: !enableSwapButton,
+      hideShowAllTokens: !enableShowAllTokensButton,
+      hideWalletConnect: !enableWalletConnect,
       buttonPosition: portfolioWidgetPosition,
       defaultPortfolio,
     };
     const whiteLabel = deepmerge.all([projectConfigWhiteLabel, uiConfig, coreOptions.walletServicesConfig?.whiteLabel || {}]);
     const confirmationStrategy =
       coreOptions.walletServicesConfig?.confirmationStrategy ??
-      (confirmationModalEnabled ? CONFIRMATION_STRATEGY.MODAL : CONFIRMATION_STRATEGY.AUTO_APPROVE);
+      (enableConfirmationModal ? CONFIRMATION_STRATEGY.MODAL : CONFIRMATION_STRATEGY.AUTO_APPROVE);
     const finalWsSettings: WalletServicesSettings = {
       ...coreOptions.walletServicesConfig,
       confirmationStrategy,
       whiteLabel,
       accountAbstractionConfig: coreOptions.accountAbstractionConfig,
       enableLogging: coreOptions.enableLogging,
-      enableKeyExport: keyExportEnabled,
+      enableKeyExport: enableKeyExport,
     };
 
     // Core options

packages/no-modal/src/noModal.ts

@@ -228,8 +228,7 @@ export class Web3AuthNoModal extends SafeEventEmitter<Web3AuthNoModalEvents> imp
   protected initChainsConfig(projectConfig: ProjectConfig) {
     // merge chains from project config with core options, core options chains will take precedence over project config chains
     const chainMap = new Map<string, CustomChainConfig>();
-    const enabledProjectConfigChains = projectConfig.chains?.filter((chain) => chain.enabled).map((chain) => chain.config) || [];
-    const allChains = [...enabledProjectConfigChains, ...(this.coreOptions.chains || [])];
+    const allChains = [...(projectConfig.chains || []), ...(this.coreOptions.chains || [])];
     for (const chain of allChains) {
       const existingChain = chainMap.get(chain.chainId);
       if (!existingChain) chainMap.set(chain.chainId, chain);
@@ -267,11 +266,11 @@ export class Web3AuthNoModal extends SafeEventEmitter<Web3AuthNoModalEvents> imp
   }
 
   protected initAccountAbstractionConfig(projectConfig?: ProjectConfig) {
-    const isAAEnabled = Boolean(this.coreOptions.accountAbstractionConfig) || projectConfig?.smartAccounts?.enabled;
+    const isAAEnabled = Boolean(this.coreOptions.accountAbstractionConfig || projectConfig?.smartAccounts);
     if (!isAAEnabled) return;
 
     // merge project config with core options, code config take precedence over project config
-    const { walletScope, ...configWithoutWalletScope } = projectConfig?.smartAccounts?.config || {};
+    const { walletScope, ...configWithoutWalletScope } = projectConfig?.smartAccounts || {};
     this.coreOptions.accountAbstractionConfig = deepmerge(configWithoutWalletScope || {}, this.coreOptions.accountAbstractionConfig || {});
 
     // determine if we should use AA with external wallet
@@ -317,7 +316,7 @@ export class Web3AuthNoModal extends SafeEventEmitter<Web3AuthNoModalEvents> imp
     };
 
     // add injected connectors
-    const isExternalWalletEnabled = projectConfig.externalWalletLogin?.enabled ?? true;
+    const isExternalWalletEnabled = Boolean(projectConfig.externalWalletLogin);
     const isMipdEnabled = isExternalWalletEnabled && (this.coreOptions.multiInjectedProviderDiscovery ?? true);
     const chainNamespaces = new Set(this.coreOptions.chains.map((chain) => chain.chainNamespace));
     if (isMipdEnabled) {