Merge pull request #2090 from Web3Auth/feat/sdk-v10-review-comments

adds review comments for sdk v10 pr

Author: chaitanyapotti

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

@@ -87,10 +87,11 @@ const options = computed((): Web3AuthOptions => {
     useAAWithExternalWallet: formData.useAAWithExternalWallet,
     // TODO: Add more options
     // enableLogging?: boolean;
-    // storageKey?: "session" | "local";
+    // storageType?: "session" | "local";
     // sessionTime?: number;
     // useCoreKitKey?: boolean;
     chains,
+    defaultChainId: formData.defaultChainId,
     enableLogging: true,
     connectors: externalConnectors.value,
     plugins,

demo/vue-app-new/src/components/AppSettings.vue

@@ -37,6 +37,10 @@ const chainOptions = computed(() => {
   return allChains;
 });
 
+const defaultChainOptions = computed(() => {
+  return formData.chains.map((chain) => ({ name: chain, value: chain }));
+});
+
 const adapterOptions = computed(() =>
   formData.chainNamespaces.includes(CHAIN_NAMESPACES.EIP155)
     ? [
@@ -90,6 +94,7 @@ const isActiveTab = (index: number) => activeTab.value === index;
 const onChainNamespaceChange = (value: string[]) => {
   log.info("onChainNamespaceChange", value);
   formData.chains = value.map((namespace) => chainConfigs[namespace as ChainNamespaceType][0]);
+  formData.defaultChainId = formData.chains[0];
   formData.connectors = [];
 };
 </script>
@@ -155,6 +160,14 @@ const onChainNamespaceChange = (value: string[]) => {
           :multiple="true"
           :options="chainOptions"
         />
+        <Select
+          v-model="formData.defaultChainId"
+          data-testid="selectDefaultChainId"
+          :label="$t('app.defaultChainId')"
+          :aria-label="$t('app.defaultChainId')"
+          :placeholder="$t('app.defaultChainId')"
+          :options="defaultChainOptions"
+        />
         <Select
           v-model="formData.connectors"
           data-testid="selectAdapters"

demo/vue-app-new/src/config.ts

@@ -102,6 +102,7 @@ export type FormData = {
   network: WEB3AUTH_NETWORK_TYPE;
   chainNamespaces: ChainNamespaceType[];
   chains: string[];
+  defaultChainId: string;
   whiteLabel: {
     enable: boolean;
     config: WhiteLabelData;

demo/vue-app-new/src/store/form.ts

@@ -9,6 +9,7 @@ export const formDataStore = reactive<FormData>({
   network: WEB3AUTH_NETWORK.TESTNET,
   chainNamespaces: [CHAIN_NAMESPACES.EIP155],
   chains: [chainConfigs[CHAIN_NAMESPACES.EIP155][0], chainConfigs[CHAIN_NAMESPACES.EIP155][1]],
+  defaultChainId: chainConfigs[CHAIN_NAMESPACES.EIP155][0],
   whiteLabel: {
     enable: false,
     config: initWhiteLabel,

demo/vue-app-new/src/translations/en.json

@@ -6,6 +6,7 @@
     "documentation": "Documentation",
     "network": "Network",
     "chains": "Chains",
+    "defaultChainId": "Default Chain ID",
     "loginProviders": "Login provider",
     "adapters": "Adapters",
     "showWalletDiscovery": "Show Wallet Discovery",

packages/modal/src/modalManager.ts

@@ -62,7 +62,7 @@ export class Web3Auth extends Web3AuthNoModal implements IWeb3AuthModal {
 
   public async initModal(params?: ModalConfigParams): Promise<void> {
     super.checkInitRequirements();
-
+    super.initCachedConnectorAndChainId();
     // get project config and wallet registry
     const { projectConfig, walletRegistry } = await this.getProjectAndWalletConfig(params);
     this.options.uiConfig = deepmerge(cloneDeep(projectConfig.whitelabel || {}), this.options.uiConfig || {});
@@ -80,10 +80,12 @@ export class Web3Auth extends Web3AuthNoModal implements IWeb3AuthModal {
     await this.loginModal.initModal();
 
     // setup common JRPC provider
-    await this.setupCommonJRPCProvider(projectConfig);
+    await this.setupCommonJRPCProvider();
 
     // initialize connectors
-    this.on(CONNECTOR_EVENTS.CONNECTORS_UPDATED, ({ connectors }) => this.initConnectors({ connectors, projectConfig, modalConfig: params }));
+    this.on(CONNECTOR_EVENTS.CONNECTORS_UPDATED, ({ connectors: newConnectors }) =>
+      this.initConnectors({ connectors: newConnectors, projectConfig, modalConfig: params })
+    );
     await this.loadConnectors({ projectConfig });
 
     // initialize plugins
@@ -171,6 +173,7 @@ export class Web3Auth extends Web3AuthNoModal implements IWeb3AuthModal {
     // update auth connector config
     const { sms_otp_enabled: smsOtpEnabled } = projectConfig;
     if (smsOtpEnabled !== undefined) {
+      // TODO: use the new login config method
       const connectorConfig: Record<WALLET_CONNECTOR_TYPE, ModalConfig> = {
         [WALLET_CONNECTORS.AUTH]: {
           label: WALLET_CONNECTORS.AUTH,

packages/no-modal/src/base/chain/config.ts

@@ -15,7 +15,7 @@ const getDefaultNetworkId = (chainNamespace: ChainNamespaceType): number => {
   }
   throw WalletInitializationError.invalidParams(`Chain namespace ${chainNamespace} is not supported`);
 };
-
+// TODO: remove this function and get this from dashboard instead
 export const getEvmChainConfig = (chainId: number, web3AuthClientId: string = ""): CustomChainConfig | null => {
   const chainNamespace = CHAIN_NAMESPACES.EIP155;
   const infuraRpcTarget = `${INFURA_PROXY_URL}/${chainId}/${web3AuthClientId}`;

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

@@ -79,11 +79,11 @@ export abstract class BaseConnector<T> extends SafeEventEmitter<ConnectorEvents>
   checkSwitchChainRequirements(params: { chainId: string }, init = false): void {
     if (!init && !this.provider) throw WalletLoginError.notConnectedError("Not connected with wallet.");
     if (!this.coreOptions.chains) throw WalletInitializationError.invalidParams("chainConfigs is required");
-    const newChainConfig = this.coreOptions.chains.find(
+    const doesChainExist = this.coreOptions.chains.some(
       (x) =>
         x.chainId === params.chainId && (x.chainNamespace === this.connectorNamespace || this.connectorNamespace === CONNECTOR_NAMESPACES.MULTICHAIN)
     );
-    if (!newChainConfig) throw WalletInitializationError.invalidParams("Invalid chainId");
+    if (!doesChainExist) throw WalletInitializationError.invalidParams("Invalid chainId");
   }
 
   updateConnectorData(data: unknown): void {

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

@@ -8,6 +8,7 @@ import {
   type CONNECTOR_STATUS_TYPE,
   ConnectorEvents,
   type ConnectorFn,
+  type IBaseProvider,
   type IConnector,
   type IProvider,
   type UserAuthInfo,
@@ -56,6 +57,12 @@ export interface IWeb3AuthCoreOptions {
    * only provided chains will be used
    */
   chains?: CustomChainConfig[];
+
+  /**
+   * default chain Id to use
+   */
+  defaultChainId?: string;
+
   /**
    * setting to true will enable logs
    *
@@ -67,18 +74,19 @@ export interface IWeb3AuthCoreOptions {
    *
    * @defaultValue "local"
    */
-  storageKey?: "session" | "local";
+  // TODO: rename this to match customauth, sfa
+  storageType?: "session" | "local";
 
   /**
    * sessionTime (in seconds) for idToken issued by Web3Auth for server side verification.
-   * @defaultValue 86400
+   * @defaultValue 7 * 86400
    *
-   * Note: max value can be 7 days (86400 * 7) and min can be  1 day (86400)
+   * 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 mainnet
+   * @defaultValue sapphire_mainnet
    */
   web3AuthNetwork?: WEB3AUTH_NETWORK_TYPE;
 
@@ -123,6 +131,11 @@ export interface IWeb3AuthCoreOptions {
    * Wallet services config
    */
   walletServicesConfig?: WalletServicesConfig;
+
+  /**
+   * Private key provider for xrpl, mpc cases
+   */
+  privateKeyProvider?: IBaseProvider<string>;
 }
 
 export interface IWeb3AuthCore extends SafeEventEmitter {

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

@@ -7,6 +7,7 @@ export interface WhitelistResponse {
   signed_urls: Record<string, string>;
 }
 
+// TODO: add more data from dashboard including chains
 export interface PROJECT_CONFIG_RESPONSE {
   whitelabel?: WhiteLabelData;
   sms_otp_enabled: boolean;