Add skipCreateStateCacheIfAvailable (#4319)

packages/beacon-node/src/chain/chain.ts

@@ -7,6 +7,7 @@ import {
   createCachedBeaconState,
   EffectiveBalanceIncrements,
   getEffectiveBalanceIncrementsZeroInactive,
+  isCachedBeaconState,
   Index2PubkeyCache,
   PubkeyIndexMap,
 } from "@lodestar/state-transition";
@@ -158,19 +159,27 @@ export class BeaconChain implements IBeaconChain {
     this.seenAggregatedAttestations = new SeenAggregatedAttestations(metrics);
     this.seenContributionAndProof = new SeenContributionAndProof(metrics);
 
-    // Initialize single global instance of state caches
-    this.pubkey2index = new PubkeyIndexMap();
-    this.index2pubkey = [];
-
     this.beaconProposerCache = new BeaconProposerCache(opts);
     this.checkpointBalancesCache = new CheckpointBalancesCache();
 
     // Restore state caches
-    const cachedState = createCachedBeaconState(anchorState, {
-      config,
-      pubkey2index: this.pubkey2index,
-      index2pubkey: this.index2pubkey,
-    });
+    // anchorState may already by a CachedBeaconState. If so, don't create the cache again, since deserializing all
+    // pubkeys takes ~30 seconds for 350k keys (mainnet 2022Q2).
+    // When the BeaconStateCache is created in eth1 genesis builder it may be incorrect. Until we can ensure that
+    // it's safe to re-use _ANY_ BeaconStateCache, this option is disabled by default and only used in tests.
+    const cachedState =
+      isCachedBeaconState(anchorState) && opts.skipCreateStateCacheIfAvailable
+        ? anchorState
+        : createCachedBeaconState(anchorState, {
+            config,
+            pubkey2index: new PubkeyIndexMap(),
+            index2pubkey: [],
+          });
+
+    // Persist single global instance of state caches
+    this.pubkey2index = cachedState.epochCtx.pubkey2index;
+    this.index2pubkey = cachedState.epochCtx.index2pubkey;
+
     const {checkpoint} = computeAnchorCheckpoint(config, anchorState);
     stateCache.add(cachedState);
     checkpointStateCache.add(checkpoint, cachedState);

packages/beacon-node/src/chain/options.ts

@@ -13,6 +13,7 @@ export type IChainOptions = BlockProcessOpts &
     blsVerifyAllMultiThread?: boolean;
     persistInvalidSszObjects?: boolean;
     persistInvalidSszObjectsDir?: string;
+    skipCreateStateCacheIfAvailable?: boolean;
     defaultFeeRecipient: string;
   };
 

packages/beacon-node/test/perf/chain/verifyImportBlocks.test.ts

@@ -83,6 +83,7 @@ describe("verify+import blocks - range sync perf test", () => {
           safeSlotsToImportOptimistically: SAFE_SLOTS_TO_IMPORT_OPTIMISTICALLY,
           disableArchiveOnCheckpoint: true,
           defaultFeeRecipient: defaultValidatorOptions.defaultFeeRecipient,
+          skipCreateStateCacheIfAvailable: true,
         },
         {
           config: state.config,

packages/state-transition/src/cache/stateCache.ts

@@ -158,3 +158,12 @@ export function getCachedBeaconState<T extends BeaconStateAllForks>(
 
   return cachedState;
 }
+
+/**
+ * Typeguard to check if a state contains a BeaconStateCache
+ */
+export function isCachedBeaconState<T extends BeaconStateAllForks>(
+  state: T | (T & BeaconStateCache)
+): state is T & BeaconStateCache {
+  return (state as T & BeaconStateCache).epochCtx !== undefined;
+}

packages/state-transition/src/index.ts

@@ -17,7 +17,7 @@ export {
 } from "./types.js";
 
 // Main state caches
-export {createCachedBeaconState, BeaconStateCache} from "./cache/stateCache.js";
+export {createCachedBeaconState, BeaconStateCache, isCachedBeaconState} from "./cache/stateCache.js";
 export {EpochContext, EpochContextImmutableData, createEmptyEpochContextImmutableData} from "./cache/epochContext.js";
 export {EpochProcess, beforeProcessEpoch} from "./cache/epochProcess.js";