@dynamic-labs-sdk/client 0.1.0-alpha.8 → 0.1.0

package/{getWalletProviderByKey.cjs.js → getVerifiedCredentialForWalletAccount.cjs.js}

@@ -1,6 +1,6 @@
 'use strict';
 
-var getChainFromVerifiedCredentialChain = require('./getChainFromVerifiedCredentialChain.cjs.js');
+var constants = require('./constants.cjs.js');
 var sdkApiCore = require('@dynamic-labs/sdk-api-core');
 
 /**
@@ -20,8 +20,8 @@ var sdkApiCore = require('@dynamic-labs/sdk-api-core');
  * @param params.listener - The callback function to execute when the event is fired.
  * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
  * @returns A function that can be called to remove the listener.
- */ const onEvent = ({ event, listener }, client = getChainFromVerifiedCredentialChain.getDefaultClient())=>{
-    const { eventEmitter } = getChainFromVerifiedCredentialChain.getCore(client);
+ */ const onEvent = ({ event, listener }, client = constants.getDefaultClient())=>{
+    const { eventEmitter } = constants.getCore(client);
     eventEmitter.on(event, listener);
     return ()=>{
         eventEmitter.off(event, listener);
@@ -36,8 +36,8 @@ var sdkApiCore = require('@dynamic-labs/sdk-api-core');
  * @param params.event - The event name to remove the listener from.
  * @param params.listener - The callback function to remove.
  * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
- */ const offEvent = ({ event, listener }, client = getChainFromVerifiedCredentialChain.getDefaultClient())=>{
-    const { eventEmitter } = getChainFromVerifiedCredentialChain.getCore(client);
+ */ const offEvent = ({ event, listener }, client = constants.getDefaultClient())=>{
+    const { eventEmitter } = constants.getCore(client);
     eventEmitter.off(event, listener);
 };
 /**
@@ -50,8 +50,8 @@ var sdkApiCore = require('@dynamic-labs/sdk-api-core');
  * @param params.listener - The callback function to execute when the event is fired.
  * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
  * @returns A function that can be called to remove the listener before it fires.
- */ const onceEvent = ({ event, listener }, client = getChainFromVerifiedCredentialChain.getDefaultClient())=>{
-    const { eventEmitter } = getChainFromVerifiedCredentialChain.getCore(client);
+ */ const onceEvent = ({ event, listener }, client = constants.getDefaultClient())=>{
+    const { eventEmitter } = constants.getCore(client);
     eventEmitter.once(event, listener);
     return ()=>{
         eventEmitter.off(event, listener);
@@ -67,10 +67,34 @@ var sdkApiCore = require('@dynamic-labs/sdk-api-core');
  * @param params.args - The arguments to pass to event listeners.
  * @param client - The Dynamic client instance.
  */ const emitEvent = ({ event, args }, client)=>{
-    const { eventEmitter } = getChainFromVerifiedCredentialChain.getCore(client);
+    const { eventEmitter } = constants.getCore(client);
     eventEmitter.emit(event, args);
 };
 
+class InvalidWalletProviderKeyError extends constants.BaseError {
+    constructor(value){
+        super({
+            cause: null,
+            code: 'invalid_wallet_provider_key',
+            docsUrl: null,
+            name: 'InvalidWalletProviderKeyError',
+            shortMessage: `Invalid wallet provider key: ${value}. Key must be in the format of <normalizedWalletNameWithChain>:<walletProviderType>[:<suffix>]`
+        });
+    }
+}
+
+const splitWalletProviderKey = (walletProviderKey)=>{
+    const [normalizedWalletNameWithChain, walletProviderType, suffix, ...rest] = walletProviderKey.split(':');
+    if (!normalizedWalletNameWithChain || !Object.values(sdkApiCore.WalletProviderEnum).includes(walletProviderType) || rest.length > 0) {
+        throw new InvalidWalletProviderKeyError(walletProviderKey);
+    }
+    return {
+        normalizedWalletNameWithChain,
+        suffix,
+        walletProviderType: walletProviderType
+    };
+};
+
 const normalizeAddress = (address, chain)=>{
     let normalizedAddress = address;
     if (normalizedAddress == null ? void 0 : normalizedAddress.startsWith('0x')) {
@@ -88,60 +112,134 @@ const normalizeAddress = (address, chain)=>{
     return normalizedAddress;
 };
 
-const createWalletAccountId = (chain, address)=>`${chain}-${normalizeAddress(address, chain)}`;
+const formatWalletAccountId = ({ address, chain, walletProviderKey })=>{
+    const { normalizedWalletNameWithChain } = splitWalletProviderKey(walletProviderKey);
+    const normalizedAddress = normalizeAddress(address, chain);
+    return `${normalizedWalletNameWithChain}:${normalizedAddress}`;
+};
 
-const convertUnverifiedWalletAccountToWalletAccount = (unverifiedWalletAccount)=>({
+const convertUnverifiedWalletAccountToWalletAccount = ({ unverifiedWalletAccount })=>({
         address: unverifiedWalletAccount.address,
+        addressesWithTypes: unverifiedWalletAccount.addressesWithTypes,
         chain: unverifiedWalletAccount.chain,
-        id: createWalletAccountId(unverifiedWalletAccount.chain, unverifiedWalletAccount.address),
+        id: formatWalletAccountId({
+            address: unverifiedWalletAccount.address,
+            chain: unverifiedWalletAccount.chain,
+            walletProviderKey: unverifiedWalletAccount.walletProviderKey
+        }),
         lastSelectedAt: unverifiedWalletAccount.lastSelectedAt,
         verifiedCredentialId: null,
         walletProviderKey: unverifiedWalletAccount.walletProviderKey
     });
 
 /**
- * Format the wallet name and chain to get a wallet provider key.
- */ const formatWalletProviderKey = (walletName, chain)=>{
-    const sanitizedWalletName = walletName.replace(/[^a-zA-Z0-9]/g, '').toLowerCase();
-    return `${sanitizedWalletName}${chain.toLocaleLowerCase()}`;
+ * Format the raw wallet name and chain to get the value we can use for
+ * verified credentials' `walletName` field.
+ */ const normalizeWalletNameWithChain = ({ displayName, chain })=>{
+    const sanitizedWalletName = displayName.replace(/[^a-zA-Z0-9]/g, '').toLowerCase();
+    const chainLowered = chain.toLocaleLowerCase();
+    if (sanitizedWalletName.endsWith(chainLowered)) {
+        return sanitizedWalletName;
+    }
+    return `${sanitizedWalletName}${chainLowered}`;
+};
+
+/**
+ * Assembles the wallet provider key from the wallet name, chain, and wallet provider type.
+ *
+ * The suffix is optional and can be used to add a uniquely identifying string to the key, which
+ * might be necessary for some wallet providers (like Wallet Connect).
+ *
+ * IMPORTANT: Do NOT add a suffix unless absolutely necessary, as it will cause the wallet account
+ * to not be able to find its wallet provider when connecting to a new device (it won't be possible
+ * to determine the full key just from the Verified Credential data).
+ */ const formatWalletProviderKey = ({ suffix, chain, displayName, walletProviderType })=>{
+    const normalizedNameWithChain = normalizeWalletNameWithChain({
+        chain,
+        displayName
+    });
+    return `${normalizedNameWithChain}:${walletProviderType}${suffix ? `:${suffix}` : ''}`;
 };
 
-const convertVerifiedCredentialToWalletAccount = (verified)=>{
-    getChainFromVerifiedCredentialChain.assertDefined(verified.address, 'Missing address in verified credential');
-    getChainFromVerifiedCredentialChain.assertDefined(verified.chain, 'Missing chain in verified credential');
-    getChainFromVerifiedCredentialChain.assertDefined(verified.walletName, 'Missing wallet name in verified credential');
-    const chain = getChainFromVerifiedCredentialChain.getChainFromVerifiedCredentialChain(verified.chain);
-    const hasChainInWalletName = verified.walletName.endsWith(chain.toLowerCase());
-    // we need to make sure the walletProviderKey follows the correct format ([walletName][chain])
-    // some walletNames will follow the legacy format (e.g. "phantom" instead of "phantomsol", "metamask" instead of "metamaskevm")
-    // so we need to make sure we parse it correctly
-    const walletProviderKey = hasChainInWalletName ? verified.walletName : formatWalletProviderKey(verified.walletName, chain);
-    var _verified_lastSelectedAt;
+const getWalletProviderKeyFromVerifiedCredential = ({ verifiedCredential }, client)=>{
+    const core = constants.getCore(client);
+    const { walletProviderKeyMap } = core.state.get();
+    const storedWalletProviderKey = walletProviderKeyMap[verifiedCredential.id];
+    if (storedWalletProviderKey) {
+        return {
+            walletProviderKey: storedWalletProviderKey
+        };
+    }
+    /**
+   * We fallback to comprising the wallet provider key from walletName and walletProvider.
+   *
+   * Some wallet provider types (like Wallet Connect) also use a special suffix for their wallet provider
+   * keys, so this won't be enough for them.
+   * Therefore, for those specific wallet providers, the wallet account will remain without a wallet provider
+   * and will require reconnection.
+   * Read walletProvider.types.ts for more info.
+   */ constants.assertDefined(verifiedCredential.walletName, `Failed to get wallet provider for verified credential with ID ${verifiedCredential.id}: missing walletName`);
+    constants.assertDefined(verifiedCredential.walletProvider, `Failed to get wallet provider for verified credential with ID ${verifiedCredential.id}: missing walletProvider`);
+    constants.assertDefined(verifiedCredential.chain, `Failed to get wallet provider for verified credential with ID ${verifiedCredential.id}: missing chain`);
+    /**
+   * Historically, walletNames did not include the chain name as a suffix.
+   * This piece of logic simply ensures we normalize any legacy walletNames to conform.
+   */ const chain = constants.getChainFromVerifiedCredentialChain(verifiedCredential.chain);
+    const walletProviderKey = formatWalletProviderKey({
+        chain,
+        displayName: verifiedCredential.walletName,
+        walletProviderType: verifiedCredential.walletProvider
+    });
+    return {
+        walletProviderKey
+    };
+};
+
+const convertVerifiedCredentialToWalletAccount = ({ verifiedCredential }, client)=>{
+    constants.assertDefined(verifiedCredential.address, 'Missing address in verified credential');
+    constants.assertDefined(verifiedCredential.chain, 'Missing chain in verified credential');
+    const chain = constants.getChainFromVerifiedCredentialChain(verifiedCredential.chain);
+    const { walletProviderKey } = getWalletProviderKeyFromVerifiedCredential({
+        verifiedCredential
+    }, client);
+    const walletAccountId = formatWalletAccountId({
+        address: verifiedCredential.address,
+        chain,
+        walletProviderKey
+    });
+    var _verifiedCredential_lastSelectedAt;
     return {
-        address: verified.address,
+        address: verifiedCredential.address,
+        addressesWithTypes: verifiedCredential.walletAdditionalAddresses,
         chain,
-        id: createWalletAccountId(chain, verified.address),
-        lastSelectedAt: (_verified_lastSelectedAt = verified.lastSelectedAt) != null ? _verified_lastSelectedAt : null,
-        verifiedCredentialId: verified.id,
+        id: walletAccountId,
+        lastSelectedAt: (_verifiedCredential_lastSelectedAt = verifiedCredential.lastSelectedAt) != null ? _verifiedCredential_lastSelectedAt : null,
+        verifiedCredentialId: verifiedCredential.id,
         walletProviderKey
     };
 };
 
-const getWalletAccountsFromState = (state)=>{
-    const { unverifiedWalletAccounts, user } = state;
+const getWalletAccountsFromState = ({ unverifiedWalletAccounts, user }, client)=>{
     const walletAccountsMap = new Map();
     /**
    * Handle the unverified wallet accounts before the user verified credentials
    * so the later verified wallet accounts can override the unverified wallet accounts
    */ unverifiedWalletAccounts.forEach((unverifiedWalletAccount)=>{
-        const walletAccount = convertUnverifiedWalletAccountToWalletAccount(unverifiedWalletAccount);
+        const walletAccount = convertUnverifiedWalletAccountToWalletAccount({
+            unverifiedWalletAccount
+        });
         walletAccountsMap.set(walletAccount.id, walletAccount);
     });
     var _user_verifiedCredentials;
     /**
    * Handle user verified credentials
    */ const verifiedCredentials = (_user_verifiedCredentials = user == null ? void 0 : user.verifiedCredentials) != null ? _user_verifiedCredentials : [];
-    verifiedCredentials.filter((verified)=>verified.format === sdkApiCore.JwtVerifiedCredentialFormatEnum.Blockchain).map((verifiedWalletAccount)=>convertVerifiedCredentialToWalletAccount(verifiedWalletAccount)).forEach((verifiedWalletAccount)=>walletAccountsMap.set(verifiedWalletAccount.id, verifiedWalletAccount));
+    verifiedCredentials.filter((verified)=>verified.format === sdkApiCore.JwtVerifiedCredentialFormatEnum.Blockchain).forEach((verifiedWalletAccount)=>{
+        const walletAccount = convertVerifiedCredentialToWalletAccount({
+            verifiedCredential: verifiedWalletAccount
+        }, client);
+        walletAccountsMap.set(walletAccount.id, walletAccount);
+    });
     return Array.from(walletAccountsMap.values());
 };
 
@@ -155,9 +253,16 @@ const getWalletAccountsFromState = (state)=>{
  *
  * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
  * @returns An array of wallet accounts associated with the session.
- */ const getWalletAccounts = (client = getChainFromVerifiedCredentialChain.getDefaultClient())=>getWalletAccountsFromState(getChainFromVerifiedCredentialChain.getCore(client).state.get());
+ */ const getWalletAccounts = (client = constants.getDefaultClient())=>{
+    const core = constants.getCore(client);
+    const { unverifiedWalletAccounts, user } = core.state.get();
+    return getWalletAccountsFromState({
+        unverifiedWalletAccounts,
+        user
+    }, client);
+};
 
-class NoWalletProviderFoundError extends getChainFromVerifiedCredentialChain.BaseError {
+class NoWalletProviderFoundError extends constants.BaseError {
     constructor({ walletProviderKey }){
         super({
             cause: null,
@@ -178,7 +283,7 @@ class NoWalletProviderFoundError extends getChainFromVerifiedCredentialChain.Bas
  * @param key - Unique identifier for the service in the registry
  * @param builder - Function that creates the service instance when called with a DynamicClient
  */ const createRuntimeServiceAccessKey = (key, builder)=>(client)=>{
-        const { runtimeServices } = getChainFromVerifiedCredentialChain.getCore(client);
+        const { runtimeServices } = constants.getCore(client);
         const currentService = runtimeServices.getByKey(key);
         if (currentService) {
             return currentService;
@@ -240,6 +345,15 @@ class NoWalletProviderFoundError extends getChainFromVerifiedCredentialChain.Bas
                     event: 'walletProviderChanged'
                 }, client);
             }
+        },
+        unregister: (key)=>{
+            registry.delete(key);
+            emitEvent({
+                args: {
+                    walletProviderKey: key
+                },
+                event: 'walletProviderUnregistered'
+            }, client);
         }
     };
 };
@@ -314,33 +428,37 @@ const DYNAMIC_AUTH_COOKIE_NAME = 'DYNAMIC_JWT_TOKEN';
 };
 
 const checkAndRaiseWalletAccountsChangedEvent = ({ previousState }, client)=>{
-    const core = getChainFromVerifiedCredentialChain.getCore(client);
-    const walletAccountsHashBefore = getWalletAccountsHash(previousState);
-    const walletAccountsHashAfter = getWalletAccountsHash(core.state.get());
+    const core = constants.getCore(client);
+    const walletAccountsHashBefore = getWalletAccountsHash(previousState, client);
+    const walletAccountsHashAfter = getWalletAccountsHash(core.state.get(), client);
     if (walletAccountsHashBefore !== walletAccountsHashAfter) {
         emitWalletAccountsChangedEvent(client);
     }
 };
-const getWalletAccountsHash = (state)=>getWalletAccountsFromState(state).map(({ id })=>id).sort().join('-');
+const getWalletAccountsHash = (state, client)=>getWalletAccountsFromState(state, client).map((walletAccount)=>JSON.stringify(walletAccount)).sort().join('-');
 
 const updateAuthFromVerifyResponse = ({ response }, client)=>{
-    const core = getChainFromVerifiedCredentialChain.getCore(client);
-    const previousState = getChainFromVerifiedCredentialChain._extends({}, core.state.get());
+    const core = constants.getCore(client);
+    const previousState = constants._extends({}, core.state.get());
     const { user, minifiedJwt, jwt, expiresAt, mfaToken } = response;
     // Expires at is in seconds, so we need to convert it to milliseconds
     const sessionExpiresAt = new Date(expiresAt * 1000);
-    core.state.set({
+    const newState = {
         legacyToken: jwt != null ? jwt : null,
-        mfaToken: mfaToken != null ? mfaToken : null,
         sessionExpiresAt: sessionExpiresAt,
         token: minifiedJwt != null ? minifiedJwt : null,
         user
-    });
+    };
+    // only override the mfaToken if a new one is provided in the response
+    if (mfaToken) {
+        newState.mfaToken = mfaToken;
+    }
+    core.state.set(newState);
     /**
    * For customers using a sandbox environment with cookies enabled, we need to set the cookie
    * programmatically because Redcoast won't set the cookie via headers. We set the cookie programmatically
    * so customers can access the cookie from document.cookie consistently between sandbox and live environments.
-   */ if (minifiedJwt && getChainFromVerifiedCredentialChain.isCookieEnabled(client)) {
+   */ if (minifiedJwt && constants.isCookieEnabled(client)) {
         const expireDate = sessionExpiresAt.toUTCString();
         setCookie(`${DYNAMIC_AUTH_COOKIE_NAME}=${minifiedJwt}; expires=${expireDate}; path=/; SameSite=Lax`);
     }
@@ -367,21 +485,31 @@ const getWalletProviderByKey = ({ walletProviderKey }, client)=>{
     return walletProvider;
 };
 
+const getVerifiedCredentialForWalletAccount = ({ walletAccount }, client)=>{
+    var _client_user;
+    return (_client_user = client.user) == null ? void 0 : _client_user.verifiedCredentials.find((vc)=>vc.id === walletAccount.verifiedCredentialId);
+};
+
 exports.DYNAMIC_AUTH_COOKIE_NAME = DYNAMIC_AUTH_COOKIE_NAME;
+exports.InvalidWalletProviderKeyError = InvalidWalletProviderKeyError;
 exports.NoWalletProviderFoundError = NoWalletProviderFoundError;
+exports.checkAndRaiseWalletAccountsChangedEvent = checkAndRaiseWalletAccountsChangedEvent;
 exports.createRuntimeServiceAccessKey = createRuntimeServiceAccessKey;
-exports.createWalletAccountId = createWalletAccountId;
 exports.emitEvent = emitEvent;
 exports.emitWalletAccountsChangedEvent = emitWalletAccountsChangedEvent;
+exports.formatWalletAccountId = formatWalletAccountId;
 exports.formatWalletProviderKey = formatWalletProviderKey;
+exports.getVerifiedCredentialForWalletAccount = getVerifiedCredentialForWalletAccount;
 exports.getWalletAccounts = getWalletAccounts;
 exports.getWalletProviderByKey = getWalletProviderByKey;
 exports.getWalletProviderFromWalletAccount = getWalletProviderFromWalletAccount;
 exports.getWalletProviderRegistry = getWalletProviderRegistry;
 exports.getWalletProviders = getWalletProviders;
 exports.normalizeAddress = normalizeAddress;
+exports.normalizeWalletNameWithChain = normalizeWalletNameWithChain;
 exports.offEvent = offEvent;
 exports.onEvent = onEvent;
 exports.onceEvent = onceEvent;
 exports.setCookie = setCookie;
+exports.splitWalletProviderKey = splitWalletProviderKey;
 exports.updateAuthFromVerifyResponse = updateAuthFromVerifyResponse;

package/{getWalletProviderByKey.esm.js → getVerifiedCredentialForWalletAccount.esm.js}

@@ -1,5 +1,5 @@
-import { g as getDefaultClient, a as getCore, e as assertDefined, k as getChainFromVerifiedCredentialChain, B as BaseError, _ as _extends, i as isCookieEnabled } from './getChainFromVerifiedCredentialChain.esm.js';
-import { JwtVerifiedCredentialFormatEnum } from '@dynamic-labs/sdk-api-core';
+import { g as getDefaultClient, a as getCore, B as BaseError, d as assertDefined, k as getChainFromVerifiedCredentialChain, _ as _extends, i as isCookieEnabled } from './constants.esm.js';
+import { WalletProviderEnum, JwtVerifiedCredentialFormatEnum } from '@dynamic-labs/sdk-api-core';
 
 /**
  * Sefelly sets the cookie in the browser.
@@ -69,6 +69,30 @@ import { JwtVerifiedCredentialFormatEnum } from '@dynamic-labs/sdk-api-core';
     eventEmitter.emit(event, args);
 };
 
+class InvalidWalletProviderKeyError extends BaseError {
+    constructor(value){
+        super({
+            cause: null,
+            code: 'invalid_wallet_provider_key',
+            docsUrl: null,
+            name: 'InvalidWalletProviderKeyError',
+            shortMessage: `Invalid wallet provider key: ${value}. Key must be in the format of <normalizedWalletNameWithChain>:<walletProviderType>[:<suffix>]`
+        });
+    }
+}
+
+const splitWalletProviderKey = (walletProviderKey)=>{
+    const [normalizedWalletNameWithChain, walletProviderType, suffix, ...rest] = walletProviderKey.split(':');
+    if (!normalizedWalletNameWithChain || !Object.values(WalletProviderEnum).includes(walletProviderType) || rest.length > 0) {
+        throw new InvalidWalletProviderKeyError(walletProviderKey);
+    }
+    return {
+        normalizedWalletNameWithChain,
+        suffix,
+        walletProviderType: walletProviderType
+    };
+};
+
 const normalizeAddress = (address, chain)=>{
     let normalizedAddress = address;
     if (normalizedAddress == null ? void 0 : normalizedAddress.startsWith('0x')) {
@@ -86,60 +110,134 @@ const normalizeAddress = (address, chain)=>{
     return normalizedAddress;
 };
 
-const createWalletAccountId = (chain, address)=>`${chain}-${normalizeAddress(address, chain)}`;
+const formatWalletAccountId = ({ address, chain, walletProviderKey })=>{
+    const { normalizedWalletNameWithChain } = splitWalletProviderKey(walletProviderKey);
+    const normalizedAddress = normalizeAddress(address, chain);
+    return `${normalizedWalletNameWithChain}:${normalizedAddress}`;
+};
 
-const convertUnverifiedWalletAccountToWalletAccount = (unverifiedWalletAccount)=>({
+const convertUnverifiedWalletAccountToWalletAccount = ({ unverifiedWalletAccount })=>({
         address: unverifiedWalletAccount.address,
+        addressesWithTypes: unverifiedWalletAccount.addressesWithTypes,
         chain: unverifiedWalletAccount.chain,
-        id: createWalletAccountId(unverifiedWalletAccount.chain, unverifiedWalletAccount.address),
+        id: formatWalletAccountId({
+            address: unverifiedWalletAccount.address,
+            chain: unverifiedWalletAccount.chain,
+            walletProviderKey: unverifiedWalletAccount.walletProviderKey
+        }),
         lastSelectedAt: unverifiedWalletAccount.lastSelectedAt,
         verifiedCredentialId: null,
         walletProviderKey: unverifiedWalletAccount.walletProviderKey
     });
 
 /**
- * Format the wallet name and chain to get a wallet provider key.
- */ const formatWalletProviderKey = (walletName, chain)=>{
-    const sanitizedWalletName = walletName.replace(/[^a-zA-Z0-9]/g, '').toLowerCase();
-    return `${sanitizedWalletName}${chain.toLocaleLowerCase()}`;
+ * Format the raw wallet name and chain to get the value we can use for
+ * verified credentials' `walletName` field.
+ */ const normalizeWalletNameWithChain = ({ displayName, chain })=>{
+    const sanitizedWalletName = displayName.replace(/[^a-zA-Z0-9]/g, '').toLowerCase();
+    const chainLowered = chain.toLocaleLowerCase();
+    if (sanitizedWalletName.endsWith(chainLowered)) {
+        return sanitizedWalletName;
+    }
+    return `${sanitizedWalletName}${chainLowered}`;
+};
+
+/**
+ * Assembles the wallet provider key from the wallet name, chain, and wallet provider type.
+ *
+ * The suffix is optional and can be used to add a uniquely identifying string to the key, which
+ * might be necessary for some wallet providers (like Wallet Connect).
+ *
+ * IMPORTANT: Do NOT add a suffix unless absolutely necessary, as it will cause the wallet account
+ * to not be able to find its wallet provider when connecting to a new device (it won't be possible
+ * to determine the full key just from the Verified Credential data).
+ */ const formatWalletProviderKey = ({ suffix, chain, displayName, walletProviderType })=>{
+    const normalizedNameWithChain = normalizeWalletNameWithChain({
+        chain,
+        displayName
+    });
+    return `${normalizedNameWithChain}:${walletProviderType}${suffix ? `:${suffix}` : ''}`;
 };
 
-const convertVerifiedCredentialToWalletAccount = (verified)=>{
-    assertDefined(verified.address, 'Missing address in verified credential');
-    assertDefined(verified.chain, 'Missing chain in verified credential');
-    assertDefined(verified.walletName, 'Missing wallet name in verified credential');
-    const chain = getChainFromVerifiedCredentialChain(verified.chain);
-    const hasChainInWalletName = verified.walletName.endsWith(chain.toLowerCase());
-    // we need to make sure the walletProviderKey follows the correct format ([walletName][chain])
-    // some walletNames will follow the legacy format (e.g. "phantom" instead of "phantomsol", "metamask" instead of "metamaskevm")
-    // so we need to make sure we parse it correctly
-    const walletProviderKey = hasChainInWalletName ? verified.walletName : formatWalletProviderKey(verified.walletName, chain);
-    var _verified_lastSelectedAt;
+const getWalletProviderKeyFromVerifiedCredential = ({ verifiedCredential }, client)=>{
+    const core = getCore(client);
+    const { walletProviderKeyMap } = core.state.get();
+    const storedWalletProviderKey = walletProviderKeyMap[verifiedCredential.id];
+    if (storedWalletProviderKey) {
+        return {
+            walletProviderKey: storedWalletProviderKey
+        };
+    }
+    /**
+   * We fallback to comprising the wallet provider key from walletName and walletProvider.
+   *
+   * Some wallet provider types (like Wallet Connect) also use a special suffix for their wallet provider
+   * keys, so this won't be enough for them.
+   * Therefore, for those specific wallet providers, the wallet account will remain without a wallet provider
+   * and will require reconnection.
+   * Read walletProvider.types.ts for more info.
+   */ assertDefined(verifiedCredential.walletName, `Failed to get wallet provider for verified credential with ID ${verifiedCredential.id}: missing walletName`);
+    assertDefined(verifiedCredential.walletProvider, `Failed to get wallet provider for verified credential with ID ${verifiedCredential.id}: missing walletProvider`);
+    assertDefined(verifiedCredential.chain, `Failed to get wallet provider for verified credential with ID ${verifiedCredential.id}: missing chain`);
+    /**
+   * Historically, walletNames did not include the chain name as a suffix.
+   * This piece of logic simply ensures we normalize any legacy walletNames to conform.
+   */ const chain = getChainFromVerifiedCredentialChain(verifiedCredential.chain);
+    const walletProviderKey = formatWalletProviderKey({
+        chain,
+        displayName: verifiedCredential.walletName,
+        walletProviderType: verifiedCredential.walletProvider
+    });
+    return {
+        walletProviderKey
+    };
+};
+
+const convertVerifiedCredentialToWalletAccount = ({ verifiedCredential }, client)=>{
+    assertDefined(verifiedCredential.address, 'Missing address in verified credential');
+    assertDefined(verifiedCredential.chain, 'Missing chain in verified credential');
+    const chain = getChainFromVerifiedCredentialChain(verifiedCredential.chain);
+    const { walletProviderKey } = getWalletProviderKeyFromVerifiedCredential({
+        verifiedCredential
+    }, client);
+    const walletAccountId = formatWalletAccountId({
+        address: verifiedCredential.address,
+        chain,
+        walletProviderKey
+    });
+    var _verifiedCredential_lastSelectedAt;
     return {
-        address: verified.address,
+        address: verifiedCredential.address,
+        addressesWithTypes: verifiedCredential.walletAdditionalAddresses,
         chain,
-        id: createWalletAccountId(chain, verified.address),
-        lastSelectedAt: (_verified_lastSelectedAt = verified.lastSelectedAt) != null ? _verified_lastSelectedAt : null,
-        verifiedCredentialId: verified.id,
+        id: walletAccountId,
+        lastSelectedAt: (_verifiedCredential_lastSelectedAt = verifiedCredential.lastSelectedAt) != null ? _verifiedCredential_lastSelectedAt : null,
+        verifiedCredentialId: verifiedCredential.id,
         walletProviderKey
     };
 };
 
-const getWalletAccountsFromState = (state)=>{
-    const { unverifiedWalletAccounts, user } = state;
+const getWalletAccountsFromState = ({ unverifiedWalletAccounts, user }, client)=>{
     const walletAccountsMap = new Map();
     /**
    * Handle the unverified wallet accounts before the user verified credentials
    * so the later verified wallet accounts can override the unverified wallet accounts
    */ unverifiedWalletAccounts.forEach((unverifiedWalletAccount)=>{
-        const walletAccount = convertUnverifiedWalletAccountToWalletAccount(unverifiedWalletAccount);
+        const walletAccount = convertUnverifiedWalletAccountToWalletAccount({
+            unverifiedWalletAccount
+        });
         walletAccountsMap.set(walletAccount.id, walletAccount);
     });
     var _user_verifiedCredentials;
     /**
    * Handle user verified credentials
    */ const verifiedCredentials = (_user_verifiedCredentials = user == null ? void 0 : user.verifiedCredentials) != null ? _user_verifiedCredentials : [];
-    verifiedCredentials.filter((verified)=>verified.format === JwtVerifiedCredentialFormatEnum.Blockchain).map((verifiedWalletAccount)=>convertVerifiedCredentialToWalletAccount(verifiedWalletAccount)).forEach((verifiedWalletAccount)=>walletAccountsMap.set(verifiedWalletAccount.id, verifiedWalletAccount));
+    verifiedCredentials.filter((verified)=>verified.format === JwtVerifiedCredentialFormatEnum.Blockchain).forEach((verifiedWalletAccount)=>{
+        const walletAccount = convertVerifiedCredentialToWalletAccount({
+            verifiedCredential: verifiedWalletAccount
+        }, client);
+        walletAccountsMap.set(walletAccount.id, walletAccount);
+    });
     return Array.from(walletAccountsMap.values());
 };
 
@@ -153,7 +251,14 @@ const getWalletAccountsFromState = (state)=>{
  *
  * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
  * @returns An array of wallet accounts associated with the session.
- */ const getWalletAccounts = (client = getDefaultClient())=>getWalletAccountsFromState(getCore(client).state.get());
+ */ const getWalletAccounts = (client = getDefaultClient())=>{
+    const core = getCore(client);
+    const { unverifiedWalletAccounts, user } = core.state.get();
+    return getWalletAccountsFromState({
+        unverifiedWalletAccounts,
+        user
+    }, client);
+};
 
 class NoWalletProviderFoundError extends BaseError {
     constructor({ walletProviderKey }){
@@ -238,6 +343,15 @@ class NoWalletProviderFoundError extends BaseError {
                     event: 'walletProviderChanged'
                 }, client);
             }
+        },
+        unregister: (key)=>{
+            registry.delete(key);
+            emitEvent({
+                args: {
+                    walletProviderKey: key
+                },
+                event: 'walletProviderUnregistered'
+            }, client);
         }
     };
 };
@@ -313,13 +427,13 @@ const DYNAMIC_AUTH_COOKIE_NAME = 'DYNAMIC_JWT_TOKEN';
 
 const checkAndRaiseWalletAccountsChangedEvent = ({ previousState }, client)=>{
     const core = getCore(client);
-    const walletAccountsHashBefore = getWalletAccountsHash(previousState);
-    const walletAccountsHashAfter = getWalletAccountsHash(core.state.get());
+    const walletAccountsHashBefore = getWalletAccountsHash(previousState, client);
+    const walletAccountsHashAfter = getWalletAccountsHash(core.state.get(), client);
     if (walletAccountsHashBefore !== walletAccountsHashAfter) {
         emitWalletAccountsChangedEvent(client);
     }
 };
-const getWalletAccountsHash = (state)=>getWalletAccountsFromState(state).map(({ id })=>id).sort().join('-');
+const getWalletAccountsHash = (state, client)=>getWalletAccountsFromState(state, client).map((walletAccount)=>JSON.stringify(walletAccount)).sort().join('-');
 
 const updateAuthFromVerifyResponse = ({ response }, client)=>{
     const core = getCore(client);
@@ -327,13 +441,17 @@ const updateAuthFromVerifyResponse = ({ response }, client)=>{
     const { user, minifiedJwt, jwt, expiresAt, mfaToken } = response;
     // Expires at is in seconds, so we need to convert it to milliseconds
     const sessionExpiresAt = new Date(expiresAt * 1000);
-    core.state.set({
+    const newState = {
         legacyToken: jwt != null ? jwt : null,
-        mfaToken: mfaToken != null ? mfaToken : null,
         sessionExpiresAt: sessionExpiresAt,
         token: minifiedJwt != null ? minifiedJwt : null,
         user
-    });
+    };
+    // only override the mfaToken if a new one is provided in the response
+    if (mfaToken) {
+        newState.mfaToken = mfaToken;
+    }
+    core.state.set(newState);
     /**
    * For customers using a sandbox environment with cookies enabled, we need to set the cookie
    * programmatically because Redcoast won't set the cookie via headers. We set the cookie programmatically
@@ -365,4 +483,9 @@ const getWalletProviderByKey = ({ walletProviderKey }, client)=>{
     return walletProvider;
 };
 
-export { DYNAMIC_AUTH_COOKIE_NAME as D, NoWalletProviderFoundError as N, WalletProviderPriority as W, getWalletProviderFromWalletAccount as a, getWalletProviderByKey as b, createWalletAccountId as c, emitWalletAccountsChangedEvent as d, emitEvent as e, getWalletProviders as f, getWalletAccounts as g, onceEvent as h, onEvent as i, createRuntimeServiceAccessKey as j, formatWalletProviderKey as k, getWalletProviderRegistry as l, normalizeAddress as n, offEvent as o, setCookie as s, updateAuthFromVerifyResponse as u };
+const getVerifiedCredentialForWalletAccount = ({ walletAccount }, client)=>{
+    var _client_user;
+    return (_client_user = client.user) == null ? void 0 : _client_user.verifiedCredentials.find((vc)=>vc.id === walletAccount.verifiedCredentialId);
+};
+
+export { DYNAMIC_AUTH_COOKIE_NAME as D, InvalidWalletProviderKeyError as I, NoWalletProviderFoundError as N, WalletProviderPriority as W, getWalletProviderFromWalletAccount as a, getWalletProviderByKey as b, checkAndRaiseWalletAccountsChangedEvent as c, emitWalletAccountsChangedEvent as d, emitEvent as e, formatWalletAccountId as f, getWalletAccounts as g, getWalletProviders as h, getVerifiedCredentialForWalletAccount as i, onceEvent as j, onEvent as k, createRuntimeServiceAccessKey as l, formatWalletProviderKey as m, normalizeAddress as n, offEvent as o, normalizeWalletNameWithChain as p, splitWalletProviderKey as q, getWalletProviderRegistry as r, setCookie as s, updateAuthFromVerifyResponse as u };