feat(store): add TS store events/ABI, move around exports (#1034)

* refactor(store): move around exports

* fix import

* diff array clone approach

packages/cli/scripts/generate-test-tables.ts

@@ -1,5 +1,6 @@
 import path from "path";
-import { tablegen } from "@latticexyz/store";
+import { StoreConfig } from "@latticexyz/store";
+import { tablegen } from "@latticexyz/store/codegen";
 import { mudConfig } from "@latticexyz/world/register";
 import { getSrcDirectory } from "@latticexyz/common/foundry";
 import { logError } from "../src/utils/errors";

packages/cli/src/commands/dev-contracts.ts

@@ -3,7 +3,8 @@ import { anvil, forge, getRpcUrl, getScriptDirectory, getSrcDirectory } from "@l
 import chalk from "chalk";
 import chokidar from "chokidar";
 import { loadConfig, resolveConfigPath } from "@latticexyz/config/node";
-import { StoreConfig, tablegen } from "@latticexyz/store";
+import { StoreConfig } from "@latticexyz/store";
+import { tablegen } from "@latticexyz/store/codegen";
 import path from "path";
 import { tsgen } from "../render-ts";
 import { debounce } from "throttle-debounce";

packages/cli/src/commands/tablegen.ts

@@ -1,7 +1,8 @@
 import path from "path";
 import type { CommandModule } from "yargs";
 import { loadConfig } from "@latticexyz/config/node";
-import { StoreConfig, tablegen } from "@latticexyz/store";
+import { StoreConfig } from "@latticexyz/store";
+import { tablegen } from "@latticexyz/store/codegen";
 import { getSrcDirectory } from "@latticexyz/common/foundry";
 
 type Options = {

packages/cli/src/render-ts/recsV1TableOptions.ts

@@ -1,4 +1,5 @@
-import { StoreConfig, resolveAbiOrUserType } from "@latticexyz/store";
+import { StoreConfig } from "@latticexyz/store";
+import { resolveAbiOrUserType } from "@latticexyz/store/codegen";
 import { schemaTypesToRecsTypeStrings } from "./schemaTypesToRecsTypeStrings";
 import { RecsV1TableOptions } from "./types";
 

packages/cli/src/utils/deploy.ts

@@ -8,7 +8,8 @@ import { getOutDirectory, getScriptDirectory, cast, forge } from "@latticexyz/co
 import { resolveWithContext } from "@latticexyz/config";
 import { MUDError } from "@latticexyz/common/errors";
 import { encodeSchema } from "@latticexyz/schema-type";
-import { StoreConfig, resolveAbiOrUserType } from "@latticexyz/store";
+import { StoreConfig } from "@latticexyz/store";
+import { resolveAbiOrUserType } from "@latticexyz/store/codegen";
 import { WorldConfig, resolveWorldConfig } from "@latticexyz/world";
 import { IBaseWorld } from "@latticexyz/world/types/ethers-contracts/IBaseWorld";
 

packages/store/package.json

@@ -10,22 +10,26 @@
   "license": "MIT",
   "type": "module",
   "exports": {
-    ".": "./dist/ts/library/index.js",
+    ".": "./dist/ts/index.js",
+    "./codegen": "./dist/ts/codegen/index.js",
+    "./config": "./dist/ts/config/index.js",
     "./register": "./dist/ts/register/index.js",
     "./abi/*": "./abi/*",
-    "./config": "./dist/ts/library/config/index.js",
     "./*": "./dist/*"
   },
   "typesVersions": {
     "*": {
       "index": [
-        "./ts/library/index.ts"
+        "./ts/index.ts"
       ],
-      "register": [
-        "./ts/register/index.ts"
+      "codegen": [
+        "./ts/codegen/index.ts"
       ],
       "config": [
-        "./ts/library/config/index.ts"
+        "./ts/config/index.ts"
+      ],
+      "register": [
+        "./ts/register/index.ts"
       ]
     }
   },
@@ -52,6 +56,7 @@
     "@latticexyz/common": "workspace:*",
     "@latticexyz/config": "workspace:*",
     "@latticexyz/schema-type": "workspace:*",
+    "abitype": "0.8.7",
     "ethers": "^5.7.2",
     "zod": "^3.21.4"
   },

packages/store/ts/library/index.ts → packages/store/ts/index.ts

@@ -1,4 +1,6 @@
 // Importing library has no side-effects, unlike register
 // (library neither creates nor extends MUDCoreContext when imported)
 export * from "./config";
-export * from "./render-solidity";
+
+export * from "./storeEvents";
+export * from "./storeEventsAbi";

packages/store/ts/register/configExtensions.ts

@@ -1,6 +1,6 @@
 import { extendMUDCoreConfig, fromZodErrorCustom } from "@latticexyz/config";
 import { ZodError } from "zod";
-import { zPluginStoreConfig } from "../library/config";
+import { zPluginStoreConfig } from "../config";
 
 extendMUDCoreConfig((config) => {
   // This function gets called within mudConfig.

packages/store/ts/register/mudConfig.ts

@@ -1,6 +1,6 @@
 import { mudCoreConfig, MUDCoreUserConfig } from "@latticexyz/config";
 import { ExtractUserTypes, StringForUnion } from "@latticexyz/common/type-utils";
-import { MUDUserConfig } from "../library";
+import { MUDUserConfig } from "..";
 import { ExpandMUDUserConfig } from "./typeExtensions";
 
 /** mudCoreConfig wrapper to use generics in some options for better type inference */

packages/store/ts/register/typeExtensions.ts

@@ -1,7 +1,7 @@
 import { OrDefaults } from "@latticexyz/common/type-utils";
 import { MUDCoreUserConfig } from "@latticexyz/config";
-import { ExpandTablesConfig, StoreConfig, StoreUserConfig } from "../library/config";
-import { DEFAULTS, PATH_DEFAULTS } from "../library/config/defaults";
+import { ExpandTablesConfig, StoreConfig, StoreUserConfig } from "../config";
+import { DEFAULTS, PATH_DEFAULTS } from "../config/defaults";
 
 // Inject non-generic options into the core config.
 // Re-exporting an interface of an existing module merges them, adding new options to the interface.

packages/store/ts/scripts/tablegen.ts

@@ -1,7 +1,8 @@
 import path from "path";
 import { loadConfig } from "@latticexyz/config/node";
 import { getSrcDirectory } from "@latticexyz/common/foundry";
-import { tablegen, StoreConfig } from "../library";
+import { tablegen } from "../codegen";
+import { StoreConfig } from "..";
 
 const config = (await loadConfig()) as StoreConfig;
 const srcDir = await getSrcDirectory();

packages/store/ts/storeEvents.ts

@@ -0,0 +1,6 @@
+export const storeEvents = [
+  "event StoreDeleteRecord(bytes32 table, bytes32[] key)",
+  "event StoreSetField(bytes32 table, bytes32[] key, uint8 schemaIndex, bytes data)",
+  "event StoreSetRecord(bytes32 table, bytes32[] key, bytes data)",
+  "event StoreEphemeralRecord(bytes32 table, bytes32[] key, bytes data)",
+] as const;

packages/store/ts/storeEventsAbi.test.ts

@@ -0,0 +1,27 @@
+import { describe, expect, it } from "vitest";
+import { storeEventsAbi } from "./storeEventsAbi";
+import { IStore__factory } from "../types/ethers-contracts";
+
+// Make sure `storeEvents` stays in sync with Solidity definition/events
+
+describe("storeEventsAbi", () => {
+  it("should match the store ABI", () => {
+    const expectedAbi = IStore__factory.abi
+      .filter((item) => item.type === "event")
+      .map((item) => ({
+        // transform because typechain adds a bunch of data that abitype doesn't care about
+        type: item.type,
+        name: item.name,
+        inputs: [
+          ...item.inputs.map((input) => ({
+            name: input.name,
+            type: input.type,
+          })),
+        ],
+      }))
+      .sort((a, b) => a.name.localeCompare(b.name));
+
+    const sortedStoreEventsAbi = [...storeEventsAbi].sort((a, b) => a.name.localeCompare(b.name));
+    expect(sortedStoreEventsAbi).toStrictEqual(expectedAbi);
+  });
+});

packages/store/ts/storeEventsAbi.ts

@@ -0,0 +1,4 @@
+import { parseAbi, AbiEvent } from "abitype";
+import { storeEvents } from "./storeEvents";
+
+export const storeEventsAbi = parseAbi(storeEvents) satisfies readonly AbiEvent[];

packages/store/tsup.config.ts

@@ -1,7 +1,7 @@
 import { defineConfig } from "tsup";
 
 export default defineConfig({
-  entry: ["mud.config.ts", "ts/library/index.ts", "ts/register/index.ts", "ts/library/config/index.ts"],
+  entry: ["mud.config.ts", "ts/index.ts", "ts/codegen/index.ts", "ts/config/index.ts", "ts/register/index.ts"],
   target: "esnext",
   format: ["esm"],
   dts: false,

packages/world/ts/plugins/snapsync/configExtensions.ts

@@ -1,5 +1,5 @@
 import { extendMUDCoreConfig, resolveTableId } from "@latticexyz/config";
-import { zPluginStoreConfig } from "@latticexyz/store/config";
+import { zPluginStoreConfig } from "@latticexyz/store";
 import { zSnapSyncPluginConfig } from "./plugin";
 import { zPluginWorldConfig } from "../../library";
 

packages/world/ts/scripts/tablegen.ts

@@ -1,7 +1,8 @@
 import path from "path";
 import { loadConfig } from "@latticexyz/config/node";
 import { getSrcDirectory } from "@latticexyz/common/foundry";
-import { StoreConfig, tablegen } from "@latticexyz/store";
+import { StoreConfig } from "@latticexyz/store";
+import { tablegen } from "@latticexyz/store/codegen";
 
 const config = (await loadConfig()) as StoreConfig;
 const srcDir = await getSrcDirectory();