@latticexyz/schema-type 1.40.0 → 2.0.0-alpha.0

package/dist/typescript/encodeSchema.js

@@ -0,0 +1,43 @@
+import { getStaticByteLength } from "./getStaticByteLength.js";
+/**
+ * Encode a table schema into a bytes32 hex string
+ * Port of `Schema.sol` from `@latticexyz/store`
+ * @param schema The schema to encode SchemaType[]
+ * @returns The encoded schema as a 32 byte hex string
+ */
+export function encodeSchema(schema) {
+    if (schema.length > 28)
+        throw new Error("Schema can only have up to 28 fields");
+    const encodedSchema = new Uint8Array(32);
+    let length = 0;
+    let staticFields = 0;
+    // Compute the length of the schema and the number of static fields
+    // and store the schema types in the encoded schema
+    let hasDynamicFields = false;
+    for (let i = 0; i < schema.length; i++) {
+        const staticByteLength = getStaticByteLength(schema[i]);
+        // Increase the static field count if the field is static
+        if (staticByteLength > 0) {
+            // Revert if we have seen a dynamic field before, but now we see a static field
+            if (hasDynamicFields)
+                throw new Error("Static fields must come before dynamic fields in the schema");
+            staticFields++;
+        }
+        else {
+            // Flag that we have seen a dynamic field
+            hasDynamicFields = true;
+        }
+        length += staticByteLength;
+        encodedSchema[i + 4] = schema[i];
+    }
+    // Require max 14 dynamic fields
+    const dynamicFields = schema.length - staticFields;
+    if (dynamicFields > 14)
+        throw new Error("Schema can only have up to 14 dynamic fields");
+    // Store total static length, and number of static and dynamic fields
+    new DataView(encodedSchema.buffer).setUint16(0, length); // 2 length bytes
+    encodedSchema[2] = staticFields; // number of static fields
+    encodedSchema[3] = dynamicFields; // number of dynamic fields
+    return encodedSchema;
+}
+//# sourceMappingURL=encodeSchema.js.map

package/dist/typescript/encodeSchema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"encodeSchema.js","sourceRoot":"","sources":["../../src/typescript/encodeSchema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAG/D;;;;;GAKG;AAEH,MAAM,UAAU,YAAY,CAAC,MAAoB;IAC/C,IAAI,MAAM,CAAC,MAAM,GAAG,EAAE;QAAE,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;IAChF,MAAM,aAAa,GAAG,IAAI,UAAU,CAAC,EAAE,CAAC,CAAC;IACzC,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,IAAI,YAAY,GAAG,CAAC,CAAC;IAErB,mEAAmE;IACnE,mDAAmD;IACnD,IAAI,gBAAgB,GAAG,KAAK,CAAC;IAC7B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;QACtC,MAAM,gBAAgB,GAAG,mBAAmB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QAExD,yDAAyD;QACzD,IAAI,gBAAgB,GAAG,CAAC,EAAE;YACxB,+EAA+E;YAC/E,IAAI,gBAAgB;gBAAE,MAAM,IAAI,KAAK,CAAC,6DAA6D,CAAC,CAAC;YACrG,YAAY,EAAE,CAAC;SAChB;aAAM;YACL,yCAAyC;YACzC,gBAAgB,GAAG,IAAI,CAAC;SACzB;QAED,MAAM,IAAI,gBAAgB,CAAC;QAC3B,aAAa,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;KAClC;IAED,gCAAgC;IAChC,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,GAAG,YAAY,CAAC;IACnD,IAAI,aAAa,GAAG,EAAE;QAAE,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC;IAExF,qEAAqE;IACrE,IAAI,QAAQ,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,iBAAiB;IAC1E,aAAa,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,CAAC,0BAA0B;IAC3D,aAAa,CAAC,CAAC,CAAC,GAAG,aAAa,CAAC,CAAC,2BAA2B;IAE7D,OAAO,aAAa,CAAC;AACvB,CAAC"}

package/dist/typescript/getStaticByteLength.d.ts

@@ -0,0 +1,2 @@
+import { SchemaType } from "./SchemaType.js";
+export declare function getStaticByteLength(schemaType: SchemaType): number;

package/dist/typescript/getStaticByteLength.js

@@ -0,0 +1,26 @@
+import { SchemaType } from "./SchemaType.js";
+export function getStaticByteLength(schemaType) {
+    const val = schemaType.valueOf();
+    if (val < 32) {
+        // uint8-256
+        return val + 1;
+    }
+    else if (val < 64) {
+        // int8-256, offset by 32
+        return val + 1 - 32;
+    }
+    else if (val < 96) {
+        // bytes1-32, offset by 64
+        return val + 1 - 64;
+    }
+    // Other static types
+    if (schemaType == SchemaType.BOOL) {
+        return 1;
+    }
+    else if (schemaType == SchemaType.ADDRESS) {
+        return 20;
+    }
+    // Return 0 for all dynamic types
+    return 0;
+}
+//# sourceMappingURL=getStaticByteLength.js.map

package/dist/typescript/getStaticByteLength.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getStaticByteLength.js","sourceRoot":"","sources":["../../src/typescript/getStaticByteLength.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAE7C,MAAM,UAAU,mBAAmB,CAAC,UAAsB;IACxD,MAAM,GAAG,GAAG,UAAU,CAAC,OAAO,EAAE,CAAC;IACjC,IAAI,GAAG,GAAG,EAAE,EAAE;QACZ,YAAY;QACZ,OAAO,GAAG,GAAG,CAAC,CAAC;KAChB;SAAM,IAAI,GAAG,GAAG,EAAE,EAAE;QACnB,yBAAyB;QACzB,OAAO,GAAG,GAAG,CAAC,GAAG,EAAE,CAAC;KACrB;SAAM,IAAI,GAAG,GAAG,EAAE,EAAE;QACnB,0BAA0B;QAC1B,OAAO,GAAG,GAAG,CAAC,GAAG,EAAE,CAAC;KACrB;IAED,qBAAqB;IACrB,IAAI,UAAU,IAAI,UAAU,CAAC,IAAI,EAAE;QACjC,OAAO,CAAC,CAAC;KACV;SAAM,IAAI,UAAU,IAAI,UAAU,CAAC,OAAO,EAAE;QAC3C,OAAO,EAAE,CAAC;KACX;IAED,iCAAiC;IACjC,OAAO,CAAC,CAAC;AACX,CAAC"}

package/dist/typescript/index.d.ts

@@ -0,0 +1,14 @@
+export type { StaticSchemaType } from "./StaticSchemaType.js";
+export type { DynamicSchemaType } from "./DynamicSchemaType.js";
+export type { ArraySchemaType } from "./ArraySchemaType.js";
+export type { SchemaTypeToPrimitive } from "./SchemaTypeToPrimitive.js";
+export type { AbiType } from "./AbiTypes.js";
+export type { StaticAbiType } from "./StaticAbiTypes.js";
+export { SchemaType } from "./SchemaType.js";
+export { encodeSchema } from "./encodeSchema.js";
+export { getStaticByteLength } from "./getStaticByteLength.js";
+export { SchemaTypeArrayToElement } from "./SchemaTypeArrayToElement.js";
+export { SchemaTypeToAbiType } from "./SchemaTypeToAbiType.js";
+export { AbiTypeToSchemaType } from "./AbiTypeToSchemaType.js";
+export { AbiTypes } from "./AbiTypes.js";
+export { StaticAbiTypes } from "./StaticAbiTypes.js";

package/dist/typescript/index.js

@@ -0,0 +1,9 @@
+export { SchemaType } from "./SchemaType.js";
+export { encodeSchema } from "./encodeSchema.js";
+export { getStaticByteLength } from "./getStaticByteLength.js";
+export { SchemaTypeArrayToElement } from "./SchemaTypeArrayToElement.js";
+export { SchemaTypeToAbiType } from "./SchemaTypeToAbiType.js";
+export { AbiTypeToSchemaType } from "./AbiTypeToSchemaType.js";
+export { AbiTypes } from "./AbiTypes.js";
+export { StaticAbiTypes } from "./StaticAbiTypes.js";
+//# sourceMappingURL=index.js.map

package/dist/typescript/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/typescript/index.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AACzE,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC"}

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@latticexyz/schema-type",
   "license": "MIT",
-  "version": "1.40.0",
+  "version": "2.0.0-alpha.0",
   "description": "SchemaType enum for various languages",
-  "main": "src/typescript/SchemaType.ts",
-  "source": "src/typescript/SchemaType.ts",
+  "main": "src/typescript/index.ts",
+  "source": "src/typescript/index.ts",
   "type": "module",
   "repository": {
     "type": "git",
@@ -28,5 +28,5 @@
     "forge-std": "https://github.com/foundry-rs/forge-std.git#b4f121555729b3afb3c5ffccb62ff4b6e2818fd3",
     "rimraf": "^3.0.2"
   },
-  "gitHead": "914a1e0ae4a573d685841ca2ea921435057deb8f"
+  "gitHead": "fcb2166c25edd27ead54f0afa1b71d2583939603"
 }

package/src/typescript/AbiTypeToSchemaType.ts

@@ -0,0 +1,6 @@
+import { SchemaTypeToAbiType } from "./SchemaTypeToAbiType.js";
+import { SchemaType } from "./SchemaType.js";
+
+export const AbiTypeToSchemaType = Object.fromEntries(
+  Object.entries(SchemaTypeToAbiType).map(([schemaType, abiType]) => [abiType, parseInt(schemaType) as SchemaType])
+) satisfies Record<string, SchemaType>;

package/src/typescript/AbiTypes.ts

@@ -0,0 +1,5 @@
+import { SchemaType } from "./SchemaType.js";
+import { SchemaTypeToAbiType } from "./SchemaTypeToAbiType.js";
+
+export type AbiType = (typeof SchemaTypeToAbiType)[SchemaType];
+export const AbiTypes = Object.values(SchemaTypeToAbiType);

package/src/typescript/ArraySchemaType.ts

@@ -0,0 +1,101 @@
+import { SchemaType } from "./SchemaType.js";
+
+export type ArraySchemaType =
+  | SchemaType.UINT8_ARRAY
+  | SchemaType.UINT16_ARRAY
+  | SchemaType.UINT24_ARRAY
+  | SchemaType.UINT32_ARRAY
+  | SchemaType.UINT40_ARRAY
+  | SchemaType.UINT48_ARRAY
+  | SchemaType.UINT56_ARRAY
+  | SchemaType.UINT64_ARRAY
+  | SchemaType.UINT72_ARRAY
+  | SchemaType.UINT80_ARRAY
+  | SchemaType.UINT88_ARRAY
+  | SchemaType.UINT96_ARRAY
+  | SchemaType.UINT104_ARRAY
+  | SchemaType.UINT112_ARRAY
+  | SchemaType.UINT120_ARRAY
+  | SchemaType.UINT128_ARRAY
+  | SchemaType.UINT136_ARRAY
+  | SchemaType.UINT144_ARRAY
+  | SchemaType.UINT152_ARRAY
+  | SchemaType.UINT160_ARRAY
+  | SchemaType.UINT168_ARRAY
+  | SchemaType.UINT176_ARRAY
+  | SchemaType.UINT184_ARRAY
+  | SchemaType.UINT192_ARRAY
+  | SchemaType.UINT200_ARRAY
+  | SchemaType.UINT208_ARRAY
+  | SchemaType.UINT216_ARRAY
+  | SchemaType.UINT224_ARRAY
+  | SchemaType.UINT232_ARRAY
+  | SchemaType.UINT240_ARRAY
+  | SchemaType.UINT248_ARRAY
+  | SchemaType.UINT256_ARRAY
+  | SchemaType.INT8_ARRAY
+  | SchemaType.INT16_ARRAY
+  | SchemaType.INT24_ARRAY
+  | SchemaType.INT32_ARRAY
+  | SchemaType.INT40_ARRAY
+  | SchemaType.INT48_ARRAY
+  | SchemaType.INT56_ARRAY
+  | SchemaType.INT64_ARRAY
+  | SchemaType.INT72_ARRAY
+  | SchemaType.INT80_ARRAY
+  | SchemaType.INT88_ARRAY
+  | SchemaType.INT96_ARRAY
+  | SchemaType.INT104_ARRAY
+  | SchemaType.INT112_ARRAY
+  | SchemaType.INT120_ARRAY
+  | SchemaType.INT128_ARRAY
+  | SchemaType.INT136_ARRAY
+  | SchemaType.INT144_ARRAY
+  | SchemaType.INT152_ARRAY
+  | SchemaType.INT160_ARRAY
+  | SchemaType.INT168_ARRAY
+  | SchemaType.INT176_ARRAY
+  | SchemaType.INT184_ARRAY
+  | SchemaType.INT192_ARRAY
+  | SchemaType.INT200_ARRAY
+  | SchemaType.INT208_ARRAY
+  | SchemaType.INT216_ARRAY
+  | SchemaType.INT224_ARRAY
+  | SchemaType.INT232_ARRAY
+  | SchemaType.INT240_ARRAY
+  | SchemaType.INT248_ARRAY
+  | SchemaType.INT256_ARRAY
+  | SchemaType.BYTES1_ARRAY
+  | SchemaType.BYTES2_ARRAY
+  | SchemaType.BYTES3_ARRAY
+  | SchemaType.BYTES4_ARRAY
+  | SchemaType.BYTES5_ARRAY
+  | SchemaType.BYTES6_ARRAY
+  | SchemaType.BYTES7_ARRAY
+  | SchemaType.BYTES8_ARRAY
+  | SchemaType.BYTES9_ARRAY
+  | SchemaType.BYTES10_ARRAY
+  | SchemaType.BYTES11_ARRAY
+  | SchemaType.BYTES12_ARRAY
+  | SchemaType.BYTES13_ARRAY
+  | SchemaType.BYTES14_ARRAY
+  | SchemaType.BYTES15_ARRAY
+  | SchemaType.BYTES16_ARRAY
+  | SchemaType.BYTES17_ARRAY
+  | SchemaType.BYTES18_ARRAY
+  | SchemaType.BYTES19_ARRAY
+  | SchemaType.BYTES20_ARRAY
+  | SchemaType.BYTES21_ARRAY
+  | SchemaType.BYTES22_ARRAY
+  | SchemaType.BYTES23_ARRAY
+  | SchemaType.BYTES24_ARRAY
+  | SchemaType.BYTES25_ARRAY
+  | SchemaType.BYTES26_ARRAY
+  | SchemaType.BYTES27_ARRAY
+  | SchemaType.BYTES28_ARRAY
+  | SchemaType.BYTES29_ARRAY
+  | SchemaType.BYTES30_ARRAY
+  | SchemaType.BYTES31_ARRAY
+  | SchemaType.BYTES32_ARRAY
+  | SchemaType.BOOL_ARRAY
+  | SchemaType.ADDRESS_ARRAY;

package/src/typescript/DynamicSchemaType.ts

@@ -0,0 +1,4 @@
+import { SchemaType } from "./SchemaType.js";
+import { ArraySchemaType } from "./ArraySchemaType.js";
+
+export type DynamicSchemaType = ArraySchemaType | SchemaType.BYTES | SchemaType.STRING;