Increment store persist version

hyperlane-xyz · Sep 18, 2023 · 798a38a · 798a38a
1 parent 79a3101
commit 798a38a
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 8 deletions.
diff --git a/src/features/chains/chainConfig.ts b/src/features/chains/chainConfig.ts
@@ -46,7 +46,7 @@ export function tryParseChainConfig(input: string, mp?: MultiProvider): ParseRes
 
   const chainConfig = result.data as ChainConfig;
 
-  // Ensure http is used for RPCs (and not http)
+  // Ensure https is used for RPCs
   const rpcUrls = chainConfig.rpcUrls;
   if (rpcUrls?.some((r) => !r.http.startsWith('https://'))) {
     return {

diff --git a/src/features/chains/useChainConfigs.ts b/src/features/chains/useChainConfigs.ts
@@ -16,13 +16,13 @@ const ChainMetadataArraySchema = z.array(ChainMetadataSchema);
 
 // Use the chainConfigs from the store
 export function useChainConfigs() {
-  return useStore((s) => s.chainConfigsV2);
+  return useStore((s) => s.chainConfigs);
 }
 
 // Use the chainConfigs and setChainConfigs from the store (i.e. Read/Write)
 export function useChainConfigsRW() {
   return useStore((s) => ({
-    chainConfigs: s.chainConfigsV2,
+    chainConfigs: s.chainConfigs,
     setChainConfigs: s.setChainConfigs,
   }));
 }

diff --git a/src/store.ts b/src/store.ts
@@ -7,10 +7,13 @@ import { ChainConfig } from './features/chains/chainConfig';
 import { buildSmartProvider } from './features/providers/SmartMultiProvider';
 import { logger } from './utils/logger';
 
+// Increment this when persist state has breaking changes
+const PERSIST_STATE_VERSION = 1;
+
 // Keeping everything here for now as state is simple
 // Will refactor into slices as necessary
 interface AppState {
-  chainConfigsV2: ChainMap<ChainConfig>; // v2 because schema changed
+  chainConfigs: ChainMap<ChainConfig>;
   setChainConfigs: (configs: ChainMap<ChainConfig>) => void;
   multiProvider: MultiProvider;
   setMultiProvider: (mp: MultiProvider) => void;
@@ -21,9 +24,9 @@ interface AppState {
 export const useStore = create<AppState>()(
   persist(
     (set) => ({
-      chainConfigsV2: {},
+      chainConfigs: {},
       setChainConfigs: (configs: ChainMap<ChainConfig>) => {
-        set({ chainConfigsV2: configs, multiProvider: buildSmartProvider(configs) });
+        set({ chainConfigs: configs, multiProvider: buildSmartProvider(configs) });
       },
       multiProvider: buildSmartProvider({}),
       setMultiProvider: (mp: MultiProvider) => {
@@ -34,15 +37,16 @@ export const useStore = create<AppState>()(
     }),
     {
       name: 'hyperlane', // name in storage
-      partialize: (state) => ({ chainConfigsV2: state.chainConfigsV2 }), // fields to persist
+      version: PERSIST_STATE_VERSION,
+      partialize: (state) => ({ chainConfigs: state.chainConfigs }), // fields to persist
       onRehydrateStorage: () => {
         logger.debug('Rehydrating state');
         return (state, error) => {
           if (error || !state) {
             logger.error('Error during hydration', error);
             return;
           }
-          state.setMultiProvider(buildSmartProvider(state.chainConfigsV2));
+          state.setMultiProvider(buildSmartProvider(state.chainConfigs));
           logger.debug('Hydration finished');
         };
       },