feat(schema-type): add type narrowing isStaticAbiType (#1196)

Co-authored-by: alvarius <alvarius@lattice.xyz>
latticexyz · Jul 27, 2023 · b02f9d0 · b02f9d0
1 parent afdba79
commit b02f9d0
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 4 deletions.
diff --git a/.changeset/pink-horses-deny.md b/.changeset/pink-horses-deny.md
@@ -0,0 +1,5 @@
+---
+"@latticexyz/schema-type": minor
+---
+
+add type narrowing `isStaticAbiType`
diff --git a/packages/schema-type/src/typescript/dynamicAbiTypes.ts b/packages/schema-type/src/typescript/dynamicAbiTypes.ts
@@ -1,5 +1,5 @@
 import { Hex } from "viem";
-import { DynamicAbiType, SchemaAbiType } from "./schemaAbiTypes";
+import { DynamicAbiType, SchemaAbiType, dynamicAbiTypes } from "./schemaAbiTypes";
 import { LiteralToBroad } from "./utils";
 import { isArrayAbiType } from "./arrayAbiTypes";
 
@@ -124,6 +124,6 @@ export type DynamicAbiTypeToPrimitiveType<TDynamicAbiType extends DynamicAbiType
   (typeof dynamicAbiTypeToDefaultValue)[TDynamicAbiType]
 >;
 
-export function isDynamicAbiType(abiType: SchemaAbiType): abiType is DynamicAbiType {
-  return isArrayAbiType(abiType) || abiType === "bytes" || abiType === "string";
+export function isDynamicAbiType(abiType: string): abiType is DynamicAbiType {
+  return dynamicAbiTypes.includes(abiType as DynamicAbiType);
 }
diff --git a/packages/schema-type/src/typescript/staticAbiTypes.ts b/packages/schema-type/src/typescript/staticAbiTypes.ts
@@ -1,5 +1,5 @@
 import { Hex } from "viem";
-import { StaticAbiType } from "./schemaAbiTypes";
+import { StaticAbiType, staticAbiTypes } from "./schemaAbiTypes";
 import { LiteralToBroad } from "./utils";
 
 // Fixed-length ABI types
@@ -217,3 +217,7 @@ export const staticAbiTypeToByteLength = {
   bool: 1,
   address: 20,
 } as const satisfies Record<StaticAbiType, number>;
+
+export function isStaticAbiType(abiType: string): abiType is StaticAbiType {
+  return staticAbiTypes.includes(abiType as StaticAbiType);
+}