CLI as workspace root dep

package.json

@@ -40,6 +40,7 @@
   "devDependencies": {
     "@ark/attest": "0.11.0",
     "@changesets/cli": "^2.27.7",
+    "@latticexyz/cli": "workspace:*",
     "@types/node": "^18.15.11",
     "@typescript-eslint/eslint-plugin": "7.1.1",
     "@typescript-eslint/parser": "7.1.1",

packages/cli/package.json

@@ -49,6 +49,7 @@
     "@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",
@@ -84,8 +85,5 @@
     "tsup": "^6.7.0",
     "tsx": "^3.12.6",
     "vitest": "0.34.6"
-  },
-  "peerDependencies": {
-    "@latticexyz/world-modules": "*"
   }
 }

packages/cli/src/deploy/configToModules.ts

@@ -6,26 +6,39 @@ import { bytesToHex } from "viem";
 import { createPrepareDeploy } from "./createPrepareDeploy";
 import { World } from "@latticexyz/world";
 import { getContractArtifact } from "../utils/getContractArtifact";
-import { knownModuleArtifacts } from "../utils/knownModuleArtifacts";
+import { importContractArtifact } from "../utils/importContractArtifact";
 import { resolveWithContext } from "@latticexyz/world/internal";
+import metadataModule from "@latticexyz/world-modules/out/MetadataModule.sol/MetadataModule.json" assert { type: "json" };
+
+/** Please don't add to this list! These are kept for backwards compatibility and assumes the downstream project has this module installed as a dependency. */
+const knownModuleArtifacts = {
+  KeysWithValueModule: "@latticexyz/world-modules/out/KeysWithValueModule.sol/KeysWithValueModule.json",
+  KeysInTableModule: "@latticexyz/world-modules/out/KeysInTableModule.sol/KeysInTableModule.json",
+  UniqueEntityModule: "@latticexyz/world-modules/out/UniqueEntityModule.sol/UniqueEntityModule.json",
+  Unstable_CallWithSignatureModule:
+    "@latticexyz/world-modules/out/Unstable_CallWithSignatureModule.sol/Unstable_CallWithSignatureModule.json",
+};
+
+const metadataModuleArtifact = getContractArtifact(metadataModule);
 
 export async function configToModules<config extends World>(
   config: config,
   // TODO: remove/replace `forgeOutDir`
   forgeOutDir: string,
 ): Promise<readonly Module[]> {
-  const configModules = [
+  const defaultModules: Module[] = [
     {
-      name: "metadata",
-      artifactPath: "@latticexyz/world-modules/out/MetadataModule.sol/MetadataModule.json",
-      root: false,
-      args: [],
+      name: "MetadataModule",
+      installAsRoot: false,
+      installData: "0x",
+      prepareDeploy: createPrepareDeploy(metadataModuleArtifact.bytecode, metadataModuleArtifact.placeholders),
+      deployedBytecodeSize: metadataModuleArtifact.deployedBytecodeSize,
+      abi: metadataModuleArtifact.abi,
     },
-    ...config.modules,
   ];
 
   const modules = await Promise.all(
-    configModules.map(async (mod): Promise<Module> => {
+    config.modules.map(async (mod): Promise<Module> => {
       let artifactPath = mod.artifactPath;
 
       // Backwards compatibility
@@ -56,7 +69,7 @@ export async function configToModules<config extends World>(
       }
 
       const name = path.basename(artifactPath, ".json");
-      const artifact = await getContractArtifact({ artifactPath });
+      const artifact = await importContractArtifact({ artifactPath });
 
       // TODO: replace args with something more strongly typed
       const installArgs = mod.args
@@ -81,5 +94,5 @@ export async function configToModules<config extends World>(
     }),
   );
 
-  return modules;
+  return [...defaultModules, ...modules];
 }

packages/cli/src/utils/getContractArtifact.ts

@@ -3,24 +3,6 @@ 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 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;
-};
 
 export type GetContractArtifactResult = {
   bytecode: Hex;
@@ -49,24 +31,7 @@ const artifactSchema = z.object({
   abi: abiSchema,
 });
 
-export async function getContractArtifact({
-  packageJsonPath,
-  artifactPath,
-}: GetContractArtifactOptions): Promise<GetContractArtifactResult> {
-  let importedArtifact;
-  try {
-    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);
-    console.error();
-    throw error;
-  }
-
+export function getContractArtifact(importedArtifact: unknown): GetContractArtifactResult {
   // TODO: improve errors or replace with arktype?
   const artifact = artifactSchema.parse(importedArtifact);
   const placeholders = findPlaceholders(artifact.bytecode.linkReferences);

packages/cli/src/utils/importContractArtifact.ts

@@ -0,0 +1,40 @@
+import { createRequire } from "node:module";
+import { findUp } from "find-up";
+import { GetContractArtifactResult } from "./getContractArtifact";
+
+export type ImportContractArtifactOptions = {
+  /**
+   * 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 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;
+};
+
+export async function importContractArtifact({
+  packageJsonPath,
+  artifactPath,
+}: ImportContractArtifactOptions): Promise<GetContractArtifactResult> {
+  let importedArtifact;
+  try {
+    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);
+    console.error();
+    throw error;
+  }
+
+  return getContractArtifact(importedArtifact);
+}

packages/world-modules/package.json

@@ -48,8 +48,6 @@
     "zod": "3.23.8"
   },
   "devDependencies": {
-    "@latticexyz/abi-ts": "workspace:*",
-    "@latticexyz/cli": "workspace:*",
     "@latticexyz/gas-report": "workspace:*",
     "@types/ejs": "^3.1.1",
     "@types/mocha": "^9.1.1",