chore: extract BasicContainerTreeViewDU from ContainerTreeViewDU

ChainSafe · Sep 20, 2024 · b9d2aee · b9d2aee
1 parent 9add9ee
commit b9d2aee
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 7 deletions.
diff --git a/packages/ssz/src/view/container.ts b/packages/ssz/src/view/container.ts
@@ -3,6 +3,7 @@ import {Type, ValueOf} from "../type/abstract";
 import {isBasicType, BasicType} from "../type/basic";
 import {isCompositeType, CompositeType} from "../type/composite";
 import {TreeView} from "./abstract";
+import type {NonOptionalFields} from "./stableContainer";
 
 export type FieldEntry<Fields extends Record<string, Type<unknown>>> = {
   fieldName: keyof Fields;
@@ -12,13 +13,16 @@ export type FieldEntry<Fields extends Record<string, Type<unknown>>> = {
 };
 
 /** Expected API of this View's type. This interface allows to break a recursive dependency between types and views */
-export type ContainerTypeGeneric<Fields extends Record<string, Type<unknown>>> = CompositeType<
+export type BasicContainerTypeGeneric<Fields extends Record<string, Type<unknown>>> = CompositeType<
   ValueOfFields<Fields>,
   ContainerTreeViewType<Fields>,
   unknown
 > & {
   readonly fields: Fields;
-  readonly fieldsEntries: FieldEntry<Fields>[];
+  readonly fieldsEntries: (FieldEntry<Fields> | FieldEntry<NonOptionalFields<Fields>>)[];
+};
+
+export type ContainerTypeGeneric<Fields extends Record<string, Type<unknown>>> = BasicContainerTypeGeneric<Fields> & {
   readonly fixedEnd: number;
 };
 
@@ -35,7 +39,7 @@ export type FieldsView<Fields extends Record<string, Type<unknown>>> = {
 };
 
 export type ContainerTreeViewType<Fields extends Record<string, Type<unknown>>> = FieldsView<Fields> &
-  TreeView<ContainerTypeGeneric<Fields>>;
+  TreeView<BasicContainerTypeGeneric<Fields>>;
 export type ContainerTreeViewTypeConstructor<Fields extends Record<string, Type<unknown>>> = {
   new (type: ContainerTypeGeneric<Fields>, tree: Tree): ContainerTreeViewType<Fields>;
 };

diff --git a/packages/ssz/src/viewDU/container.ts b/packages/ssz/src/viewDU/container.ts
@@ -9,7 +9,7 @@ import {
 import {ByteViews, Type} from "../type/abstract";
 import {BasicType, isBasicType} from "../type/basic";
 import {CompositeType, isCompositeType, CompositeTypeAny} from "../type/composite";
-import {ContainerTypeGeneric} from "../view/container";
+import {BasicContainerTypeGeneric, ContainerTypeGeneric} from "../view/container";
 import {TreeViewDU} from "./abstract";
 
 /* eslint-disable @typescript-eslint/member-ordering */
@@ -36,8 +36,8 @@ type ContainerTreeViewDUCache = {
   nodesPopulated: boolean;
 };
 
-class ContainerTreeViewDU<Fields extends Record<string, Type<unknown>>> extends TreeViewDU<
-  ContainerTypeGeneric<Fields>
+export class BasicContainerTreeViewDU<Fields extends Record<string, Type<unknown>>> extends TreeViewDU<
+  BasicContainerTypeGeneric<Fields>
 > {
   protected nodes: Node[] = [];
   protected caches: unknown[];
@@ -46,7 +46,7 @@ class ContainerTreeViewDU<Fields extends Record<string, Type<unknown>>> extends
   private nodesPopulated: boolean;
 
   constructor(
-    readonly type: ContainerTypeGeneric<Fields>,
+    readonly type: BasicContainerTypeGeneric<Fields>,
     protected _rootNode: Node,
     cache?: ContainerTreeViewDUCache
   ) {
@@ -147,6 +147,16 @@ class ContainerTreeViewDU<Fields extends Record<string, Type<unknown>>> extends
     // However preserving _SOME_ caches results in a very unpredictable experience.
     this.viewsChanged.clear();
   }
+}
+
+class ContainerTreeViewDU<Fields extends Record<string, Type<unknown>>> extends BasicContainerTreeViewDU<Fields> {
+  constructor(
+    readonly type: ContainerTypeGeneric<Fields>,
+    protected _rootNode: Node,
+    cache?: ContainerTreeViewDUCache
+  ) {
+    super(type, _rootNode, cache);
+  }
 
   /**
    * Same method to `type/container.ts` that call ViewDU.serializeToBytes() of internal fields.