Add config option for cache namespace (#3580)

* add config option for cache namespace

* move wormhole-connect: prefix

* deal with circular dep

* clean up interface

Author: artursapek

wormhole-connect/src/config/index.ts

@@ -51,15 +51,23 @@ export function buildConfig(
     customConfig.wrappedTokens,
   );
 
+  const cacheKey = (name: string) => {
+    if (customConfig.cacheNamespace) {
+      return `wormhole-connect:${customConfig.cacheNamespace}:${name}`;
+    } else {
+      return `wormhole-connect:${name}`;
+    }
+  };
+
   const tokens = buildTokenCache(
-    network,
     [
       ...networkData.tokens,
       ...(customConfig.tokensConfig
         ? Object.values(customConfig.tokensConfig)
         : []),
     ],
     wrappedTokens,
+    cacheKey(`token-cache:${network}`),
   );
 
   const sdkConfig = LEGACY_CONFIG[network.toUpperCase()];
@@ -147,6 +155,9 @@ export function buildConfig(
     // UI details
     ui: createUiConfig({ ...customConfig.ui }),
 
+    // Used to namespace localStorage caches
+    cacheKey,
+
     // Guardian Set
     guardianSet: networkData.guardianSet,
 

wormhole-connect/src/config/tokens.ts

@@ -7,7 +7,6 @@ import {
   TokenAddress,
   toNative,
   isNative,
-  Network,
   chainToPlatform,
   UniversalAddress,
 } from '@wormhole-foundation/sdk';
@@ -507,12 +506,12 @@ export class TokenCache extends TokenMapping<Token> {
 
 // Seed a new TokenCache using hard-coded tokens
 export function buildTokenCache(
-  network: Network,
   tokens: TokenConfig[],
   wrappedTokens: WrappedTokenAddresses,
+  cacheKey: string,
   tokenFilter?: string[],
 ): TokenCache {
-  const cache = TokenCache.load(`wormhole-connect:token-cache:${network}`);
+  const cache = TokenCache.load(cacheKey);
 
   for (const { tokenId, symbol, name, icon, decimals } of tokens) {
     const token = new Token(

wormhole-connect/src/config/types.ts

@@ -111,6 +111,9 @@ export interface WormholeConnectConfig {
   // Custom tokens
   tokensConfig?: TokensConfig;
 
+  // Used to namespace localStorage caches
+  cacheNamespace?: string;
+
   // Wormhole-wrapped token addresses
   wrappedTokens?: WrappedTokenAddresses;
 
@@ -174,6 +177,9 @@ export interface InternalConfig<N extends Network> {
   // UI configuration
   ui: UiConfig;
 
+  // Used to namespace localStorage caches
+  cacheKey: (name: string) => string;
+
   guardianSet: GuardianSetData;
 
   transactionSettings: TransactionSettings;

wormhole-connect/src/utils/inProgressTxCache.ts

@@ -1,7 +1,8 @@
+import config from 'config';
 import { TransactionLocal } from 'config/types';
 import { isEmptyObject } from 'utils';
 
-const LOCAL_STORAGE_KEY = 'wormhole-connect:transactions:inprogress';
+const LOCAL_STORAGE_KEY = 'transactions:inprogress';
 const LOCAL_STORAGE_MAX = 3;
 
 // Bigint types cannot be serialized to a string
@@ -112,7 +113,10 @@ export const getTxsFromLocalStorage = ():
   // Find the in-progress transactions list in localStorage
   for (let i = 0; i < ls.length; i++) {
     const itemKey = ls.key(i);
-    if (itemKey?.toLowerCase() === LOCAL_STORAGE_KEY) {
+    if (
+      itemKey?.toLowerCase() ===
+      config.cacheKey(LOCAL_STORAGE_KEY).toLowerCase()
+    ) {
       const item = ls.getItem(itemKey);
       if (item) {
         try {
@@ -124,7 +128,7 @@ export const getTxsFromLocalStorage = ():
               `Error while parsing localStorage item ${LOCAL_STORAGE_KEY}: Not an array of valid transactions`,
             );
             // Remove invalid transactions entry
-            ls.removeItem(LOCAL_STORAGE_KEY);
+            ls.removeItem(config.cacheKey(LOCAL_STORAGE_KEY));
             return;
           }
         } catch (e: any) {
@@ -135,7 +139,7 @@ export const getTxsFromLocalStorage = ():
             `Error while parsing localStorage item ${LOCAL_STORAGE_KEY}: ${e}`,
           );
           // Remove item
-          ls.removeItem(LOCAL_STORAGE_KEY);
+          ls.removeItem(config.cacheKey(LOCAL_STORAGE_KEY));
           return;
         }
       }
@@ -167,7 +171,10 @@ export const addTxToLocalStorage = (
 
   // Update the list
   try {
-    ls.setItem(LOCAL_STORAGE_KEY, JSON.stringify(newList, JSONReplacer));
+    ls.setItem(
+      config.cacheKey(LOCAL_STORAGE_KEY),
+      JSON.stringify(newList, JSONReplacer),
+    );
   } catch (e: any) {
     // We can get two different errors:
     // 1- TypeError from JSON.stringify
@@ -191,7 +198,10 @@ export const removeTxFromLocalStorage = (txHash: string) => {
       // remove the item and update localStorage
       items.splice(removeIndex, 1);
       try {
-        ls.setItem(LOCAL_STORAGE_KEY, JSON.stringify(items, JSONReplacer));
+        ls.setItem(
+          config.cacheKey(LOCAL_STORAGE_KEY),
+          JSON.stringify(items, JSONReplacer),
+        );
       } catch (e: any) {
         // We can get two different errors:
         // 1- TypeError from JSON.stringify
@@ -221,7 +231,10 @@ export const updateTxInLocalStorage = (
       // Update item property and put back in local storage
       items[idx][key] = value;
       try {
-        ls.setItem(LOCAL_STORAGE_KEY, JSON.stringify(items, JSONReplacer));
+        ls.setItem(
+          config.cacheKey(LOCAL_STORAGE_KEY),
+          JSON.stringify(items, JSONReplacer),
+        );
       } catch (e: any) {
         // We can get two different errors:
         // 1- TypeError from JSON.stringify

wormhole-connect/src/utils/wallet/index.ts

@@ -129,7 +129,7 @@ export const connectWallet = async (
     setTimeout(() => {
       dispatch(clearWallet(type));
     }, 0);
-    localStorage.removeItem(`wormhole-connect:wallet:${platform}`);
+    localStorage.removeItem(config.cacheKey(`wallet:${platform}`));
   });
 
   // when the user has multiple wallets connected and either changes
@@ -145,7 +145,7 @@ export const connectWallet = async (
   });
 
   if (name !== ReadOnlyWallet.NAME) {
-    localStorage.setItem(`wormhole-connect:wallet:${platform}`, name);
+    localStorage.setItem(config.cacheKey(`wallet:${platform}`), name);
   }
 
   return true;
@@ -159,9 +159,9 @@ export const connectLastUsedWallet = async (
   dispatch: Dispatch<any>,
 ) => {
   const chainConfig = config.chains[chain!]!;
-  const localStorageKey = `wormhole-connect:wallet:${chainToPlatform(
-    chainConfig.sdkName,
-  )}`;
+  const localStorageKey = config.cacheKey(
+    `wallet:${chainToPlatform(chainConfig.sdkName)}`,
+  );
   const lastUsedWallet = localStorage.getItem(localStorageKey);
 
   // if the last used wallet is not WalletConnect, try to connect to it