chore: more comments for Snapshot type

ChainSafe · Sep 12, 2024 · db0e5b6 · db0e5b6
1 parent bee151d
commit db0e5b6
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/packages/ssz/src/util/types.ts b/packages/ssz/src/util/types.ts
@@ -1,6 +1,10 @@
 export type Require<T, K extends keyof T> = T & Required<Pick<T, K>>;
 
-/** Snapshot for PartialListCompositeType */
+/**
+ * A snapshot contains the minimum amount of information needed to reconstruct a merkleized list, for the purposes of appending more items.
+ * Note: This does not contain list elements, rather only contains intermediate merkle nodes.
+ * This is used primarily for PartialListCompositeType.
+ */
 export type Snapshot = {
   finalized: Uint8Array[];
   root: Uint8Array;