@latticexyz/schema-type - npm Package Compare versions

Comparing version 1.40.0 to 1.41.0

dist/typescript/SchemaType.d.ts

@@ -405,1 +405,8 @@ export declare enum SchemaType {
 export type DynamicSchemaType = ArraySchemaType | SchemaType.BYTES | SchemaType.STRING;
+/**
+ * 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 declare function encodeSchema(schema: SchemaType[]): Uint8Array;

dist/typescript/SchemaType.js

@@ -528,2 +528,43 @@ // WARNING: SchemaType enum MUST mirror the solidity version!
 };
+/**
+ * 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=SchemaType.js.map

package.json

 {
   "name": "@latticexyz/schema-type",
   "license": "MIT",
-  "version": "1.40.0",
+  "version": "1.41.0",
   "description": "SchemaType enum for various languages",
@@ -31,3 +31,3 @@ "main": "src/typescript/SchemaType.ts",
   },
-  "gitHead": "914a1e0ae4a573d685841ca2ea921435057deb8f"
+  "gitHead": "ecac84146f0288e3a129d1d3dbfaf373db86b1ab"
 }

src/typescript/SchemaType.ts

@@ -644,1 +644,45 @@ // WARNING: SchemaType enum MUST mirror the solidity version!
 export type DynamicSchemaType = ArraySchemaType | SchemaType.BYTES | SchemaType.STRING;
+
+/**
+ * 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: SchemaType[]): Uint8Array {
+  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;
+}

No alert changes

Improved metrics

Total package byte prevSize

83320

increased by7.67%

Number of package files

8

increased by14.29%

Lines of code

1650

increased by5.43%

No dependency changes