Refactor nodes for consistency (#130)

* Rename StructFieldTypeNode.child to StructFieldTypeNode.type * Refactor StructFieldTypeNode.defaultTo into defaultValue and defaultValueStrategy * Refactor AmountTypeNode.identifier to an optional unit attribute * Rename ArrayTypeNode.child to item * Refactor mapTypeNode helper * Rename OptionTypeNode.child to item * Rename SetTypeNode.child to item * Rename TupleTypeNode.children to items * Refactor EnumValueNode * Remove getValueNodeFragment in favour of ValueNodeVisitor * Add GlobalFragmentScope in js-experimental render map * Rename DefinedTypeNode.data to type * Rename InstructionAccountNode.defaultsTo to defaultValue * Add comments * Refactor TypeNode registration * Refactor Node registration * Rename NODE_KEYS to NODE_KINDS * Refactor ValueNode registration * Update ValueNode.ts * Update SizeNode.ts * Use NodeKind instead of NodeKinds in types * Update PdaSeedNode.ts * Rename RegisteredNodes to NodeDictionary * Use NodeKind instead of keyof NodeDictionary * Update instructionBytesCreatedOnChain.ts * Update LinkNode.ts * Update ContextualValueNode.ts * Add PdaSeedValueNode * Add MapEntryValueNode * Add StructFieldValueNode * Add changeset
metaplex-foundation · Jan 2, 2024 · 3ef61bb · 3ef61bb
1 parent b3ec72c
commit 3ef61bb
Show file tree

Hide file tree

Showing 168 changed files with 1,628 additions and 1,340 deletions.
diff --git a/.changeset/late-games-grab.md b/.changeset/late-games-grab.md
@@ -0,0 +1,5 @@
+---
+'@metaplex-foundation/kinobi': minor
+---
+
+Refactor nodes for consistency
diff --git a/src/nodes/AccountDataNode.ts b/src/nodes/AccountDataNode.ts
@@ -4,9 +4,13 @@ import { StructTypeNode } from './typeNodes';
 
 export type AccountDataNode = {
   readonly kind: 'accountDataNode';
-  readonly name: MainCaseString;
+
+  // Children.
   readonly struct: StructTypeNode;
   readonly link?: DefinedTypeLinkNode;
+
+  // Data.
+  readonly name: MainCaseString;
 };
 
 export type AccountDataNodeInput = {

diff --git a/src/nodes/DefinedTypeNode.ts b/src/nodes/DefinedTypeNode.ts
@@ -6,7 +6,7 @@ export type DefinedTypeNode = {
   readonly kind: 'definedTypeNode';
 
   // Children.
-  readonly data: TypeNode;
+  readonly type: TypeNode;
 
   // Data.
   readonly name: MainCaseString;
@@ -17,7 +17,7 @@ export type DefinedTypeNode = {
 
 export type DefinedTypeNodeInput = {
   readonly name: string;
-  readonly data: TypeNode;
+  readonly type: TypeNode;
   readonly idlName?: string;
   readonly docs?: string[];
   readonly internal?: boolean;
@@ -30,7 +30,7 @@ export function definedTypeNode(input: DefinedTypeNodeInput): DefinedTypeNode {
   return {
     kind: 'definedTypeNode',
     name: mainCase(input.name),
-    data: input.data,
+    type: input.type,
     idlName: input.idlName ?? input.name,
     docs: input.docs ?? [],
     internal: input.internal ?? false,
@@ -42,6 +42,6 @@ export function definedTypeNodeFromIdl(
 ): DefinedTypeNode {
   const name = idl.name ?? '';
   const idlType = idl.type ?? { kind: 'struct', fields: [] };
-  const data = createTypeNodeFromIdl(idlType);
-  return definedTypeNode({ name, data, idlName: name, docs: idl.docs });
+  const type = createTypeNodeFromIdl(idlType);
+  return definedTypeNode({ name, type, idlName: name, docs: idl.docs });
 }
diff --git a/src/nodes/ErrorNode.ts b/src/nodes/ErrorNode.ts
@@ -8,6 +8,8 @@ import {
 
 export type ErrorNode = {
   readonly kind: 'errorNode';
+
+  // Data.
   readonly name: MainCaseString;
   readonly idlName: string;
   readonly code: number;

diff --git a/src/nodes/InstructionAccountNode.ts b/src/nodes/InstructionAccountNode.ts
@@ -6,7 +6,7 @@ export type InstructionAccountNode = {
   readonly kind: 'instructionAccountNode';
 
   // Children.
-  readonly defaultsTo?: InstructionInputValueNode;
+  readonly defaultValue?: InstructionInputValueNode;
 
   // Data.
   readonly name: MainCaseString;
@@ -33,7 +33,7 @@ export function instructionAccountNode(
     isSigner: input.isSigner,
     isOptional: input.isOptional ?? false,
     docs: input.docs ?? [],
-    defaultsTo: input.defaultsTo,
+    defaultValue: input.defaultValue,
   };
 }
 

diff --git a/src/nodes/InstructionDataArgsNode.ts b/src/nodes/InstructionDataArgsNode.ts
@@ -4,9 +4,13 @@ import { StructTypeNode } from './typeNodes';
 
 export type InstructionDataArgsNode = {
   readonly kind: 'instructionDataArgsNode';
-  readonly name: MainCaseString;
+
+  // Children.
   readonly struct: StructTypeNode;
   readonly link?: DefinedTypeLinkNode;
+
+  // Data.
+  readonly name: MainCaseString;
 };
 
 export type InstructionDataArgsNodeInput = Omit<

diff --git a/src/nodes/InstructionExtraArgsNode.ts b/src/nodes/InstructionExtraArgsNode.ts
@@ -4,9 +4,13 @@ import { StructTypeNode } from './typeNodes';
 
 export type InstructionExtraArgsNode = {
   readonly kind: 'instructionExtraArgsNode';
-  readonly name: MainCaseString;
+
+  // Children.
   readonly struct: StructTypeNode;
   readonly link?: DefinedTypeLinkNode;
+
+  // Data.
+  readonly name: MainCaseString;
 };
 
 export type InstructionExtraArgsNodeInput = Omit<

diff --git a/src/nodes/InstructionNode.ts b/src/nodes/InstructionNode.ts
@@ -105,11 +105,9 @@ export function instructionNodeFromIdl(
   if (idl.discriminant) {
     const discriminatorField = structFieldTypeNode({
       name: 'discriminator',
-      child: createTypeNodeFromIdl(idl.discriminant.type),
-      defaultsTo: {
-        strategy: 'omitted',
-        value: numberValueNode(idl.discriminant.value),
-      },
+      type: createTypeNodeFromIdl(idl.discriminant.type),
+      defaultValue: numberValueNode(idl.discriminant.value),
+      defaultValueStrategy: 'omitted',
     });
     dataArgs = structTypeNode([discriminatorField, ...dataArgs.fields]);
   }

diff --git a/src/nodes/Node.ts b/src/nodes/Node.ts
@@ -1,3 +1,4 @@
+import { getNodeKinds } from '../shared/utils';
 import type { AccountDataNode } from './AccountDataNode';
 import type { AccountNode } from './AccountNode';
 import type { DefinedTypeNode } from './DefinedTypeNode';
@@ -40,58 +41,53 @@ const REGISTERED_NODES = {
   ...REGISTERED_VALUE_NODES,
 };
 
-export const REGISTERED_NODES_KEYS = Object.keys(
-  REGISTERED_NODES
-) as (keyof RegisteredNodes)[];
-
-export type RegisteredNodes = typeof REGISTERED_NODES;
+export const REGISTERED_NODE_KINDS = getNodeKinds(REGISTERED_NODES);
+export type NodeDictionary = typeof REGISTERED_NODES;
+export type NodeKind = keyof NodeDictionary;
+export type Node = NodeDictionary[NodeKind];
 
 // Node Helpers.
 
-export type Node = RegisteredNodes[keyof RegisteredNodes];
-
-export function isNode<TKeys extends keyof RegisteredNodes>(
+export function isNode<TKind extends NodeKind>(
   node: Node | null | undefined,
-  key: TKeys | TKeys[]
-): node is RegisteredNodes[TKeys] {
-  const keys = Array.isArray(key) ? key : [key];
-  return !!node && (keys as (keyof RegisteredNodes)[]).includes(node.kind);
+  kind: TKind | TKind[]
+): node is NodeDictionary[TKind] {
+  const kinds = Array.isArray(kind) ? kind : [kind];
+  return !!node && (kinds as NodeKind[]).includes(node.kind);
 }
 
-export function assertIsNode<TKeys extends keyof RegisteredNodes>(
+export function assertIsNode<TKind extends NodeKind>(
   node: Node | null | undefined,
-  key: TKeys | TKeys[]
-): asserts node is RegisteredNodes[TKeys] {
-  const keys = Array.isArray(key) ? key : [key];
-  if (!isNode(node, keys)) {
+  kind: TKind | TKind[]
+): asserts node is NodeDictionary[TKind] {
+  const kinds = Array.isArray(kind) ? kind : [kind];
+  if (!isNode(node, kinds)) {
     throw new Error(
-      `Expected ${keys.join(' | ')}, got ${node?.kind ?? 'null'}.`
+      `Expected ${kinds.join(' | ')}, got ${node?.kind ?? 'null'}.`
     );
   }
 }
 
-export function isNodeFilter<TKeys extends keyof RegisteredNodes>(
-  key: TKeys | TKeys[]
-): (node: Node | null | undefined) => node is RegisteredNodes[TKeys] {
-  return (node): node is RegisteredNodes[TKeys] => isNode(node, key);
+export function isNodeFilter<TKind extends NodeKind>(
+  kind: TKind | TKind[]
+): (node: Node | null | undefined) => node is NodeDictionary[TKind] {
+  return (node): node is NodeDictionary[TKind] => isNode(node, kind);
 }
 
-export function assertIsNodeFilter<TKeys extends keyof RegisteredNodes>(
-  key: TKeys | TKeys[]
-): (node: Node | null | undefined) => node is RegisteredNodes[TKeys] {
-  return (node): node is RegisteredNodes[TKeys] => {
-    assertIsNode(node, key);
+export function assertIsNodeFilter<TKind extends NodeKind>(
+  kind: TKind | TKind[]
+): (node: Node | null | undefined) => node is NodeDictionary[TKind] {
+  return (node): node is NodeDictionary[TKind] => {
+    assertIsNode(node, kind);
     return true;
   };
 }
 
-export function removeNullAndAssertIsNodeFilter<
-  TKeys extends keyof RegisteredNodes
->(
-  key: TKeys | TKeys[]
-): (node: Node | null | undefined) => node is RegisteredNodes[TKeys] {
-  return (node): node is RegisteredNodes[TKeys] => {
-    if (node) assertIsNode(node, key);
+export function removeNullAndAssertIsNodeFilter<TKind extends NodeKind>(
+  kind: TKind | TKind[]
+): (node: Node | null | undefined) => node is NodeDictionary[TKind] {
+  return (node): node is NodeDictionary[TKind] => {
+    if (node) assertIsNode(node, kind);
     return node != null;
   };
 }
diff --git a/src/nodes/PdaNode.ts b/src/nodes/PdaNode.ts
@@ -20,8 +20,12 @@ import {
 
 export type PdaNode = {
   readonly kind: 'pdaNode';
-  readonly name: MainCaseString;
+
+  // Children.
   readonly seeds: PdaSeedNode[];
+
+  // Data.
+  readonly name: MainCaseString;
 };
 
 export function pdaNode(name: string, seeds: PdaSeedNode[]): PdaNode {

diff --git a/src/nodes/RootNode.ts b/src/nodes/RootNode.ts
@@ -11,6 +11,8 @@ export type IdlInputs = string | Partial<Idl> | (string | Partial<Idl>)[];
 
 export type RootNode = {
   readonly kind: 'rootNode';
+
+  // Children.
   readonly programs: ProgramNode[];
 };
 

diff --git a/src/nodes/contextualValueNodes/AccountBumpValueNode.ts b/src/nodes/contextualValueNodes/AccountBumpValueNode.ts
@@ -2,6 +2,8 @@ import { MainCaseString, mainCase } from '../../shared';
 
 export type AccountBumpValueNode = {
   readonly kind: 'accountBumpValueNode';
+
+  // Data.
   readonly name: MainCaseString;
 };
 

diff --git a/src/nodes/contextualValueNodes/AccountValueNode.ts b/src/nodes/contextualValueNodes/AccountValueNode.ts
@@ -2,6 +2,8 @@ import { MainCaseString, mainCase } from '../../shared';
 
 export type AccountValueNode = {
   readonly kind: 'accountValueNode';
+
+  // Data.
   readonly name: MainCaseString;
 };
 

diff --git a/src/nodes/contextualValueNodes/ArgumentValueNode.ts b/src/nodes/contextualValueNodes/ArgumentValueNode.ts
@@ -2,6 +2,8 @@ import { MainCaseString, mainCase } from '../../shared';
 
 export type ArgumentValueNode = {
   readonly kind: 'argumentValueNode';
+
+  // Data.
   readonly name: MainCaseString;
 };
 

diff --git a/src/nodes/contextualValueNodes/ConditionalValueNode.ts b/src/nodes/contextualValueNodes/ConditionalValueNode.ts
@@ -13,6 +13,8 @@ export const CONDITIONAL_VALUE_BRANCH_NODES = INSTRUCTION_INPUT_VALUE_NODE;
 
 export type ConditionalValueNode = {
   readonly kind: 'conditionalValueNode';
+
+  // Children.
   readonly condition: ResolverValueNode | AccountValueNode | ArgumentValueNode;
   readonly value?: ValueNode;
   readonly ifTrue?: ConditionalValueBranch;

diff --git a/src/nodes/contextualValueNodes/ContextualValueNode.ts b/src/nodes/contextualValueNodes/ContextualValueNode.ts
@@ -1,4 +1,4 @@
-import type { Mutable } from '../../shared';
+import { getNodeKinds } from '../../shared/utils';
 import type { ProgramLinkNode } from '../linkNodes/ProgramLinkNode';
 import { VALUE_NODES, ValueNode } from '../valueNodes/ValueNode';
 import type { AccountBumpValueNode } from './AccountBumpValueNode';
@@ -7,13 +7,14 @@ import type { ArgumentValueNode } from './ArgumentValueNode';
 import type { ConditionalValueNode } from './ConditionalValueNode';
 import type { IdentityValueNode } from './IdentityValueNode';
 import type { PayerValueNode } from './PayerValueNode';
+import type { PdaSeedValueNode } from './PdaSeedValueNode';
 import type { PdaValueNode } from './PdaValueNode';
 import type { ProgramIdValueNode } from './ProgramIdValueNode';
 import type { ResolverValueNode } from './ResolverValueNode';
 
-// Node Group Registration.
+// Standalone Contextual Value Node Registration.
 
-export const REGISTERED_CONTEXTUAL_VALUE_NODES = {
+export const STANDALONE_CONTEXTUAL_VALUE_NODES = {
   accountBumpValueNode: {} as AccountBumpValueNode,
   accountValueNode: {} as AccountValueNode,
   argumentValueNode: {} as ArgumentValueNode,
@@ -25,32 +26,43 @@ export const REGISTERED_CONTEXTUAL_VALUE_NODES = {
   resolverValueNode: {} as ResolverValueNode,
 };
 
-export const REGISTERED_CONTEXTUAL_VALUE_NODE_KEYS = Object.keys(
-  REGISTERED_CONTEXTUAL_VALUE_NODES
-) as (keyof typeof REGISTERED_CONTEXTUAL_VALUE_NODES)[];
+export const STANDALONE_CONTEXTUAL_VALUE_NODE_KINDS = getNodeKinds(
+  STANDALONE_CONTEXTUAL_VALUE_NODES
+);
+export type StandaloneContextualValueNodeKind =
+  typeof STANDALONE_CONTEXTUAL_VALUE_NODE_KINDS[number];
+export type StandaloneContextualValueNode =
+  typeof STANDALONE_CONTEXTUAL_VALUE_NODES[StandaloneContextualValueNodeKind];
+
+// Contextual Value Node Registration.
+
+export const REGISTERED_CONTEXTUAL_VALUE_NODES = {
+  ...STANDALONE_CONTEXTUAL_VALUE_NODES,
 
-export type RegisteredContextualValueNodes =
-  typeof REGISTERED_CONTEXTUAL_VALUE_NODES;
+  // The following are not valid standalone nodes.
+  pdaSeedValueNode: {} as PdaSeedValueNode,
+};
 
-// Node Group Helpers.
+export const REGISTERED_CONTEXTUAL_VALUE_NODE_KINDS = getNodeKinds(
+  REGISTERED_CONTEXTUAL_VALUE_NODES
+);
+export type RegisteredContextualValueNodeKind =
+  typeof REGISTERED_CONTEXTUAL_VALUE_NODE_KINDS[number];
+export type RegisteredContextualValueNode =
+  typeof REGISTERED_CONTEXTUAL_VALUE_NODES[RegisteredContextualValueNodeKind];
 
-export type ContextualValueNode =
-  RegisteredContextualValueNodes[keyof RegisteredContextualValueNodes];
+// Contextual Value Node Helpers.
 
-export const CONTEXTUAL_VALUE_NODES = REGISTERED_CONTEXTUAL_VALUE_NODE_KEYS;
+export type ContextualValueNode = StandaloneContextualValueNode;
+export const CONTEXTUAL_VALUE_NODES = STANDALONE_CONTEXTUAL_VALUE_NODE_KINDS;
 
 export type InstructionInputValueNode =
   | ValueNode
   | ContextualValueNode
   | ProgramLinkNode;
 
-const INSTRUCTION_INPUT_VALUE_NODE_INTERNAL = [
+export const INSTRUCTION_INPUT_VALUE_NODE = [
   ...VALUE_NODES,
   ...CONTEXTUAL_VALUE_NODES,
-  'programLinkNode',
-] as const;
-
-export const INSTRUCTION_INPUT_VALUE_NODE =
-  INSTRUCTION_INPUT_VALUE_NODE_INTERNAL as Mutable<
-    typeof INSTRUCTION_INPUT_VALUE_NODE_INTERNAL
-  >;
+  'programLinkNode' as const,
+];
diff --git a/src/nodes/contextualValueNodes/PdaSeedValueNode.ts b/src/nodes/contextualValueNodes/PdaSeedValueNode.ts
@@ -0,0 +1,21 @@
+import { MainCaseString, mainCase } from '../../shared';
+import { ValueNode } from '../valueNodes';
+import { AccountValueNode } from './AccountValueNode';
+import { ArgumentValueNode } from './ArgumentValueNode';
+
+export type PdaSeedValueNode = {
+  readonly kind: 'pdaSeedValueNode';
+
+  // Children.
+  readonly value: ValueNode | AccountValueNode | ArgumentValueNode;
+
+  // Data.
+  readonly name: MainCaseString;
+};
+
+export function pdaSeedValueNode(
+  name: string,
+  value: PdaSeedValueNode['value']
+): PdaSeedValueNode {
+  return { kind: 'pdaSeedValueNode', name: mainCase(name), value };
+}