path for compressed records

Author: frolic

packages/cli/package.json

@@ -69,6 +69,7 @@
     "p-retry": "^5.1.2",
     "path": "^0.12.7",
     "rxjs": "7.5.5",
+    "solady": "^0.1.26",
     "throttle-debounce": "^5.0.0",
     "toposort": "^2.0.2",
     "viem": "2.35.1",

packages/cli/src/mirror/createRecordHandler.ts

@@ -17,6 +17,7 @@ import { readContract, waitForTransactionReceipt } from "viem/actions";
 import chalk from "chalk";
 import { StoreRecord } from "./executeMirrorPlan";
 import { debug } from "./debug";
+import { LibZip } from "solady";
 
 export function createRecordHandler({
   client,
@@ -127,8 +128,8 @@ Estimated L2 cost at 100k wei: ${parseFloat(formatEther(BigInt(estimatedGas) * 1
     });
 
     const changedRecords = records.filter((record, i) => {
-      const recordEncoded = encodeAbiParameters(tableRecordAbi, [record]);
-      const existingRecordEncoded = encodeAbiParameters(tableRecordAbi, [existingRecords[i]]);
+      const recordEncoded = encodeAbiParameters([tableRecordAbiItem], [record]);
+      const existingRecordEncoded = encodeAbiParameters([tableRecordAbiItem], [existingRecords[i]]);
       if (recordEncoded === existingRecordEncoded) return false;
       // console.log("record changed in", record.tableId);
       // console.log("  ", recordEncoded);
@@ -139,12 +140,24 @@ Estimated L2 cost at 100k wei: ${parseFloat(formatEther(BigInt(estimatedGas) * 1
       return;
     }
 
+    const calldata = encodeAbiParameters(
+      [{ type: "bytes32" }, tableRecordsAbiItem],
+      [changedRecords[0].tableId, changedRecords],
+    );
     const args = encodeSystemCall({
       systemId: batchStoreConfig.systems.BatchStoreSystem.systemId,
       abi: batchStoreSystemAbi,
-      functionName: "_setTableRecords",
-      args: [changedRecords[0].tableId, changedRecords],
+      functionName: "_setTableRecords_flz",
+      args: [LibZip.flzCompress(calldata) as Hex],
     });
+    // console.log(
+    //   "flz compression",
+    //   size(calldata),
+    //   "=>",
+    //   size(LibZip.flzCompress(calldata) as Hex),
+    //   " = ",
+    //   size(LibZip.flzCompress(calldata) as Hex) / size(calldata),
+    // );
     const hash = await writeContract(client, {
       chain: client.chain ?? null,
       address: worldAddress,
@@ -159,35 +172,59 @@ Estimated L2 cost at 100k wei: ${parseFloat(formatEther(BigInt(estimatedGas) * 1
   return { set, finalize };
 }
 
-const tableRecordAbi = [
-  {
-    name: "record",
-    type: "tuple",
-    internalType: "struct TableRecord",
-    components: [
-      {
-        name: "keyTuple",
-        type: "bytes32[]",
-        internalType: "bytes32[]",
-      },
-      {
-        name: "staticData",
-        type: "bytes",
-        internalType: "bytes",
-      },
-      {
-        name: "encodedLengths",
-        type: "bytes32",
-        internalType: "EncodedLengths",
-      },
-      {
-        name: "dynamicData",
-        type: "bytes",
-        internalType: "bytes",
-      },
-    ],
-  },
-] as const;
+const tableRecordAbiItem = {
+  type: "tuple",
+  internalType: "struct TableRecord",
+  components: [
+    {
+      name: "keyTuple",
+      type: "bytes32[]",
+      internalType: "bytes32[]",
+    },
+    {
+      name: "staticData",
+      type: "bytes",
+      internalType: "bytes",
+    },
+    {
+      name: "encodedLengths",
+      type: "bytes32",
+      internalType: "EncodedLengths",
+    },
+    {
+      name: "dynamicData",
+      type: "bytes",
+      internalType: "bytes",
+    },
+  ],
+} as const;
+
+const tableRecordsAbiItem = {
+  type: "tuple[]",
+  internalType: "struct TableRecord[]",
+  components: [
+    {
+      name: "keyTuple",
+      type: "bytes32[]",
+      internalType: "bytes32[]",
+    },
+    {
+      name: "staticData",
+      type: "bytes",
+      internalType: "bytes",
+    },
+    {
+      name: "encodedLengths",
+      type: "bytes32",
+      internalType: "EncodedLengths",
+    },
+    {
+      name: "dynamicData",
+      type: "bytes",
+      internalType: "bytes",
+    },
+  ],
+};
 
 const batchStoreSystemAbi = [
   {
@@ -248,6 +285,19 @@ const batchStoreSystemAbi = [
     outputs: [],
     stateMutability: "nonpayable",
   },
+  {
+    type: "function",
+    name: "_setTableRecords_flz",
+    inputs: [
+      {
+        name: "data",
+        type: "bytes",
+        internalType: "bytes",
+      },
+    ],
+    outputs: [],
+    stateMutability: "nonpayable",
+  },
   {
     type: "function",
     name: "deleteTableRecords",

packages/world-module-batchstore/package.json

@@ -44,7 +44,8 @@
   "dependencies": {
     "@latticexyz/schema-type": "workspace:*",
     "@latticexyz/store": "workspace:*",
-    "@latticexyz/world": "workspace:*"
+    "@latticexyz/world": "workspace:*",
+    "solady": "^0.1.26"
   },
   "devDependencies": {
     "@latticexyz/abi-ts": "workspace:*",

packages/world-module-batchstore/remappings.txt

@@ -1,2 +1,3 @@
 forge-std/=node_modules/forge-std/src/
 @latticexyz/=node_modules/@latticexyz/
+solady/=node_modules/solady/src/

packages/world-module-batchstore/src/BatchStoreSystem.sol

@@ -9,6 +9,9 @@ import { StoreCore } from "@latticexyz/store/src/StoreCore.sol";
 import { EncodedLengths } from "@latticexyz/store/src/EncodedLengths.sol";
 import { FieldLayout } from "@latticexyz/store/src/FieldLayout.sol";
 import { TableRecord } from "./common.sol";
+import { LibZip } from "solady/utils/LibZip.sol";
+import { revertWithBytes } from "@latticexyz/world/src/revertWithBytes.sol";
+import { IBaseWorld } from "@latticexyz/world/src/codegen/interfaces/IBaseWorld.sol";
 
 contract BatchStoreSystem is System {
   function getTableRecords(
@@ -61,7 +64,7 @@ contract BatchStoreSystem is System {
     }
   }
 
-  function _setTableRecords(ResourceId tableId, TableRecord[] memory records) external {
+  function _setTableRecords(ResourceId tableId, TableRecord[] memory records) public {
     AccessControl.requireOwner(ROOT_NAMESPACE_ID, _msgSender());
 
     FieldLayout fieldLayout = StoreCore.getFieldLayout(tableId);
@@ -87,4 +90,12 @@ contract BatchStoreSystem is System {
       StoreCore.deleteRecord(tableId, keyTuples[i], fieldLayout);
     }
   }
+
+  function _setTableRecords_flz(bytes calldata data) external {
+    (ResourceId tableId, TableRecord[] memory records) = abi.decode(
+      LibZip.flzDecompress(data),
+      (ResourceId, TableRecord[])
+    );
+    _setTableRecords(tableId, records);
+  }
 }