chore: add more comments

ChainSafe · Apr 17, 2024 · 799b089 · 799b089
1 parent 4553da6
commit 799b089
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/packages/beacon-node/src/chain/stateCache/fifoBlockStateCache.ts b/packages/beacon-node/src/chain/stateCache/fifoBlockStateCache.ts
@@ -69,7 +69,9 @@ export class FIFOBlockStateCache implements BlockStateCache {
   }
 
   /**
-   * Get a seed state for state reload.
+   * Get a seed state for state reload, this could be any states. The goal is to have the same
+   * base merkle tree for all BeaconState objects across application.
+   * See packages/state-transition/src/util/loadState/loadState.ts for more detail
    */
   getSeedState(): CachedBeaconStateAllForks {
     const firstValue = this.cache.values().next();

diff --git a/packages/beacon-node/src/chain/stateCache/stateContextCache.ts b/packages/beacon-node/src/chain/stateCache/stateContextCache.ts
@@ -80,6 +80,7 @@ export class StateContextCache implements BlockStateCache {
   /**
    * Get a seed state for state reload.
    * This is to conform to the api only as this cache is not used in n-historical state.
+   * See ./fifoBlockStateCache.ts for implementation
    */
   getSeedState(): CachedBeaconStateAllForks {
     throw Error("Not implemented for StateContextCache");