fix(cli): fixed module artifactPath imports (#2832)

latticexyz · May 15, 2024 · fe9d726 · fe9d726
1 parent 6f85872
commit fe9d726
Show file tree

Hide file tree

Showing 10 changed files with 112 additions and 335 deletions.
diff --git a/.changeset/smart-moose-run.md b/.changeset/smart-moose-run.md
@@ -0,0 +1,5 @@
+---
+"@latticexyz/cli": patch
+---
+
+Fixed imports of module artifacts via `artifactPath` and removed unused `@latticexyz/world-modules` dependency.
diff --git a/e2e/packages/contracts/package.json b/e2e/packages/contracts/package.json
@@ -16,6 +16,7 @@
     "@latticexyz/schema-type": "link:../../../packages/schema-type",
     "@latticexyz/store": "link:../../../packages/store",
     "@latticexyz/world": "link:../../../packages/world",
+    "@latticexyz/world-modules": "link:../../../packages/world-modules",
     "dotenv": "^16.0.3",
     "ds-test": "https://github.com/dapphub/ds-test.git#e282159d5170298eb2455a6c05280ab5a73a4ef0",
     "forge-std": "https://github.com/foundry-rs/forge-std.git#74cfb77e308dd188d2f58864aaf44963ae6b88b1",

diff --git a/e2e/pnpm-lock.yaml b/e2e/pnpm-lock.yaml
diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -42,7 +42,6 @@
     "@latticexyz/store": "workspace:*",
     "@latticexyz/utils": "workspace:*",
     "@latticexyz/world": "workspace:*",
-    "@latticexyz/world-modules": "workspace:*",
     "abitype": "1.0.0",
     "asn1.js": "^5.4.1",
     "chalk": "^5.0.1",
@@ -51,6 +50,7 @@
     "dotenv": "^16.0.3",
     "ethers": "^5.7.2",
     "execa": "^7.0.0",
+    "find-up": "^6.3.0",
     "glob": "^8.0.3",
     "openurl": "^1.1.1",
     "p-queue": "^7.4.1",

diff --git a/packages/cli/src/deploy/common.ts b/packages/cli/src/deploy/common.ts
@@ -2,7 +2,6 @@ import { Abi, Address, Hex, padHex } from "viem";
 import storeConfig from "@latticexyz/store/mud.config";
 import worldConfig from "@latticexyz/world/mud.config";
 import IBaseWorldAbi from "@latticexyz/world/out/IBaseWorld.sol/IBaseWorld.abi.json" assert { type: "json" };
-import IModuleAbi from "@latticexyz/world-modules/out/IModule.sol/IModule.abi.json" assert { type: "json" };
 import { Tables, configToTables } from "./configToTables";
 import { helloStoreEvent } from "@latticexyz/store";
 import { StoreConfig } from "@latticexyz/store/internal";
@@ -22,7 +21,7 @@ export const worldTables = configToTables(worldToV1(worldConfig));
 
 export const worldDeployEvents = [helloStoreEvent, helloWorldEvent] as const;
 
-export const worldAbi = [...IBaseWorldAbi, ...IModuleAbi] as const;
+export const worldAbi = IBaseWorldAbi;
 
 // Ideally, this should be an append-only list. Before adding more versions here, be sure to add backwards-compatible support for old Store/World versions.
 export const supportedStoreVersions = ["2.0.0", "2.0.1", "2.0.2"];

diff --git a/packages/cli/src/deploy/configToModules.ts b/packages/cli/src/deploy/configToModules.ts
@@ -11,6 +11,7 @@ import { knownModuleArtifacts } from "../utils/knownModuleArtifacts";
 
 export async function configToModules<config extends World>(
   config: config,
+  // TODO: remove/replace `forgeOutDir`
   forgeOutDir: string,
 ): Promise<readonly Module[]> {
   // this expects a namespaced table name when used with `resolveTableId`

diff --git a/packages/cli/src/deploy/ensureModules.ts b/packages/cli/src/deploy/ensureModules.ts
@@ -38,6 +38,7 @@ export async function ensureModules({
         pRetry(
           async () => {
             try {
+              // append module's ABI so that we can decode any custom errors
               const abi = [...worldAbi, ...mod.abi];
               const moduleAddress = mod.prepareDeploy(deployerAddress, libraries).address;
               return mod.installAsRoot

diff --git a/packages/cli/src/utils/getContractArtifact.ts b/packages/cli/src/utils/getContractArtifact.ts
@@ -3,13 +3,21 @@ import { LibraryPlaceholder } from "../deploy/common";
 import { findPlaceholders } from "./findPlaceholders";
 import { z } from "zod";
 import { Abi as abiSchema } from "abitype/zod";
+import { createRequire } from "node:module";
+import { findUp } from "find-up";
 
 export type GetContractArtifactOptions = {
+  /**
+   * Path to `package.json` where `artifactPath`s are resolved relative to.
+   *
+   * Defaults to nearest `package.json` relative to `process.cwd()`.
+   */
+  packageJsonPath?: string;
   /**
    * Import path to contract's forge/solc JSON artifact with the contract's compiled bytecode.
    *
-   * This path is resolved using node's contract resolution, so this supports both relative file paths (`../path/to/MyModule.json`) as well as JS import paths
-   * (`@latticexyz/world-contracts/out/CallWithSignatureModule.sol/CallWithSignatureModule.json`).
+   * This path is resolved using node's module resolution relative to `configPath`, so this supports both
+   * relative file paths (`../path/to/MyModule.json`) as well as JS import paths (`@latticexyz/world-contracts/out/CallWithSignatureModule.sol/CallWithSignatureModule.json`).
    */
   artifactPath: string;
 };
@@ -42,17 +50,16 @@ const artifactSchema = z.object({
 });
 
 export async function getContractArtifact({
+  packageJsonPath,
   artifactPath,
 }: GetContractArtifactOptions): Promise<GetContractArtifactResult> {
   let importedArtifact;
   try {
-    importedArtifact = (
-      await import(artifactPath, {
-        with: { type: "json" },
-        // `with` is the new approach, but `assert` is kept for backwards-compatibility with Node 18
-        assert: { type: "json" },
-      })
-    ).default;
+    const requirePath = packageJsonPath ?? (await findUp("package.json", { cwd: process.cwd() }));
+    if (!requirePath) throw new Error("Could not find package.json to import relative to.");
+
+    const require = createRequire(requirePath);
+    importedArtifact = require(artifactPath);
   } catch (error) {
     console.error();
     console.error("Could not import contract artifact at", artifactPath);