feat(cli): hardcode table ID with codegen (#2229)

latticexyz · Feb 2, 2024 · a35c05e · a35c05e
1 parent db7798b
commit a35c05e
Show file tree

Hide file tree

Showing 70 changed files with 274 additions and 387 deletions.
diff --git a/.changeset/blue-roses-listen.md b/.changeset/blue-roses-listen.md
@@ -0,0 +1,10 @@
+---
+"@latticexyz/cli": patch
+"@latticexyz/common": patch
+"@latticexyz/store": patch
+"@latticexyz/world-modules": patch
+"@latticexyz/world": patch
+"create-mud": patch
+---
+
+Table libraries now hardcode the `bytes32` table ID value rather than computing it in Solidity. This saves a bit of gas across all storage operations.
diff --git a/e2e/packages/contracts/src/codegen/tables/Multi.sol b/e2e/packages/contracts/src/codegen/tables/Multi.sol
diff --git a/e2e/packages/contracts/src/codegen/tables/Number.sol b/e2e/packages/contracts/src/codegen/tables/Number.sol
diff --git a/e2e/packages/contracts/src/codegen/tables/NumberList.sol b/e2e/packages/contracts/src/codegen/tables/NumberList.sol
diff --git a/e2e/packages/contracts/src/codegen/tables/Position.sol b/e2e/packages/contracts/src/codegen/tables/Position.sol
diff --git a/e2e/packages/contracts/src/codegen/tables/StaticArray.sol b/e2e/packages/contracts/src/codegen/tables/StaticArray.sol
diff --git a/e2e/packages/contracts/src/codegen/tables/Vector.sol b/e2e/packages/contracts/src/codegen/tables/Vector.sol
diff --git a/examples/minimal/packages/contracts/src/codegen/tables/CounterTable.sol b/examples/minimal/packages/contracts/src/codegen/tables/CounterTable.sol
diff --git a/examples/minimal/packages/contracts/src/codegen/tables/Inventory.sol b/examples/minimal/packages/contracts/src/codegen/tables/Inventory.sol
diff --git a/examples/minimal/packages/contracts/src/codegen/tables/MessageTable.sol b/examples/minimal/packages/contracts/src/codegen/tables/MessageTable.sol
diff --git a/examples/multiple-accounts/packages/contracts/src/codegen/tables/LastCall.sol b/examples/multiple-accounts/packages/contracts/src/codegen/tables/LastCall.sol
diff --git a/packages/cli/contracts/src/codegen/tables/Dynamics1.sol b/packages/cli/contracts/src/codegen/tables/Dynamics1.sol
diff --git a/packages/cli/contracts/src/codegen/tables/Dynamics2.sol b/packages/cli/contracts/src/codegen/tables/Dynamics2.sol
diff --git a/packages/cli/contracts/src/codegen/tables/Offchain.sol b/packages/cli/contracts/src/codegen/tables/Offchain.sol
diff --git a/packages/cli/contracts/src/codegen/tables/Singleton.sol b/packages/cli/contracts/src/codegen/tables/Singleton.sol
diff --git a/packages/cli/contracts/src/codegen/tables/Statics.sol b/packages/cli/contracts/src/codegen/tables/Statics.sol
diff --git a/packages/cli/contracts/src/codegen/tables/UserTyped.sol b/packages/cli/contracts/src/codegen/tables/UserTyped.sol
diff --git a/packages/common/src/codegen/render-solidity/common.test.ts b/packages/common/src/codegen/render-solidity/common.test.ts
@@ -62,34 +62,20 @@ describe("renderTableId", () => {
   it("returns Solidity code to compute table ID", () => {
     expect(renderTableId({ namespace: "somewhere", name: "Player", offchainOnly: false, tableIdName: "PlayerTableId" }))
       .toMatchInlineSnapshot(`
-      "
-          ResourceId constant _tableId = ResourceId.wrap(
-            bytes32(
-              abi.encodePacked(
-                RESOURCE_TABLE,
-                bytes14(\\"somewhere\\"),
-                bytes16(\\"Player\\")
-              )
-            )
-          );
-          ResourceId constant PlayerTableId = _tableId;
         "
-    `);
+            // Hex below is the result of \`WorldResourceIdLib.encode({ namespace: \\"somewhere\\", name: \\"Player\\", typeId: RESOURCE_TABLE });\`
+            ResourceId constant _tableId = ResourceId.wrap(0x7462736f6d6577686572650000000000506c6179657200000000000000000000);
+            ResourceId constant PlayerTableId = _tableId;
+          "
+      `);
   });
 
   it("returns Solidity code to compute offchain table ID", () => {
     expect(renderTableId({ namespace: "somewhere", name: "Player", offchainOnly: true, tableIdName: "PlayerTableId" }))
       .toMatchInlineSnapshot(`
         "
-            ResourceId constant _tableId = ResourceId.wrap(
-              bytes32(
-                abi.encodePacked(
-                  RESOURCE_OFFCHAIN_TABLE,
-                  bytes14(\\"somewhere\\"),
-                  bytes16(\\"Player\\")
-                )
-              )
-            );
+            // Hex below is the result of \`WorldResourceIdLib.encode({ namespace: \\"somewhere\\", name: \\"Player\\", typeId: RESOURCE_OFFCHAIN_TABLE });\`
+            ResourceId constant _tableId = ResourceId.wrap(0x6f74736f6d6577686572650000000000506c6179657200000000000000000000);
             ResourceId constant PlayerTableId = _tableId;
           "
       `);

diff --git a/packages/common/src/codegen/render-solidity/common.ts b/packages/common/src/codegen/render-solidity/common.ts
@@ -8,6 +8,7 @@ import {
   RenderType,
 } from "./types";
 import { posixPath } from "../utils";
+import { resourceToHex } from "../../resourceToHex";
 
 /**
  * Common header for all codegenerated solidity files
@@ -213,15 +214,14 @@ export function renderTableId({
   tableIdName,
 }: Pick<StaticResourceData, "namespace" | "name" | "offchainOnly" | "tableIdName">): string {
   return `
-    ResourceId constant _tableId = ResourceId.wrap(
-      bytes32(
-        abi.encodePacked(
-          ${offchainOnly ? "RESOURCE_OFFCHAIN_TABLE" : "RESOURCE_TABLE"},
-          bytes14("${namespace}"),
-          bytes16("${name}")
-        )
-      )
-    );
+    // Hex below is the result of \`WorldResourceIdLib.encode({ namespace: ${JSON.stringify(
+      namespace
+    )}, name: ${JSON.stringify(name)}, typeId: ${offchainOnly ? "RESOURCE_OFFCHAIN_TABLE" : "RESOURCE_TABLE"} });\`
+    ResourceId constant _tableId = ResourceId.wrap(${resourceToHex({
+      type: offchainOnly ? "offchainTable" : "table",
+      namespace,
+      name,
+    })});
     ResourceId constant ${tableIdName} = _tableId;
   `;
 }