feat(cli): mud init command

.changeset/great-peas-kick.md

@@ -0,0 +1,7 @@
+---
+"@latticexyz/cli": patch
+---
+
+Added the `mud init` command, which populates the current project with the MUD artefacts for a given World.
+
+Currently it generates the `deploys` folder and `worlds.json` file.

packages/cli/src/commands/index.ts

@@ -14,6 +14,7 @@ import test from "./test";
 import trace from "./trace";
 import devContracts from "./dev-contracts";
 import verify from "./verify";
+import init from "./init";
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any -- Each command has different options
 export const commands: CommandModule<any, any>[] = [
@@ -30,4 +31,5 @@ export const commands: CommandModule<any, any>[] = [
   devContracts,
   abiTs,
   verify,
+  init,
 ];

packages/cli/src/commands/init.ts

@@ -0,0 +1,49 @@
+import type { CommandModule, InferredOptionTypes } from "yargs";
+import { loadConfig } from "@latticexyz/config/node";
+import { World as WorldConfig } from "@latticexyz/world";
+import { getRpcUrl } from "@latticexyz/common/foundry";
+import { Hex, createWalletClient, http } from "viem";
+import { getWorldDeploy } from "../deploy/getWorldDeploy";
+import { writeDeploymentResult } from "../utils/writeDeploymentResult";
+
+const verifyOptions = {
+  configPath: { type: "string", desc: "Path to the MUD config file" },
+  worldAddress: { type: "string", required: true, desc: "Verify an existing World at the given address" },
+  profile: { type: "string", desc: "The foundry profile to use" },
+  rpc: { type: "string", desc: "The RPC URL to use. Defaults to the RPC url from the local foundry.toml" },
+} as const;
+
+type Options = InferredOptionTypes<typeof verifyOptions>;
+
+const commandModule: CommandModule<Options, Options> = {
+  command: "init",
+
+  describe: "Populates the local project with the MUD artefacts for a given World.",
+
+  builder(yargs) {
+    return yargs.options(verifyOptions);
+  },
+
+  async handler(opts) {
+    const profile = opts.profile ?? process.env.FOUNDRY_PROFILE;
+
+    const config = (await loadConfig(opts.configPath)) as WorldConfig;
+
+    const rpc = opts.rpc ?? (await getRpcUrl(profile));
+
+    const client = createWalletClient({
+      transport: http(rpc),
+    });
+
+    const worldDeploy = await getWorldDeploy(client, opts.worldAddress as Hex);
+
+    const deploymentInfo = {
+      worldAddress: worldDeploy.address,
+      blockNumber: Number(worldDeploy.deployBlock),
+    };
+
+    writeDeploymentResult({ client, config, deploymentInfo });
+  },
+};
+
+export default commandModule;

packages/cli/src/runDeploy.ts

@@ -1,5 +1,3 @@
-import path from "node:path";
-import { existsSync, mkdirSync, readFileSync, writeFileSync } from "node:fs";
 import { InferredOptionTypes, Options } from "yargs";
 import { deploy } from "./deploy/deploy";
 import { createWalletClient, http, Hex, isHex } from "viem";
@@ -11,12 +9,12 @@ import { getOutDirectory, getRpcUrl, getSrcDirectory } from "@latticexyz/common/
 import chalk from "chalk";
 import { MUDError } from "@latticexyz/common/errors";
 import { resolveConfig } from "./deploy/resolveConfig";
-import { getChainId } from "viem/actions";
 import { postDeploy } from "./utils/postDeploy";
 import { WorldDeploy } from "./deploy/common";
 import { build } from "./build";
 import { kmsKeyToAccount } from "@latticexyz/common/kms";
 import { configToModules } from "./deploy/configToModules";
+import { writeDeploymentResult } from "./utils/writeDeploymentResult";
 
 export const deployOptions = {
   configPath: { type: "string", desc: "Path to the MUD config file" },
@@ -154,25 +152,7 @@ export async function runDeploy(opts: DeployOptions): Promise<WorldDeploy> {
   };
 
   if (opts.saveDeployment) {
-    const chainId = await getChainId(client);
-    const deploysDir = path.join(config.deploysDirectory, chainId.toString());
-    mkdirSync(deploysDir, { recursive: true });
-    writeFileSync(path.join(deploysDir, "latest.json"), JSON.stringify(deploymentInfo, null, 2));
-    writeFileSync(path.join(deploysDir, Date.now() + ".json"), JSON.stringify(deploymentInfo, null, 2));
-
-    const localChains = [1337, 31337];
-    const deploys = existsSync(config.worldsFile) ? JSON.parse(readFileSync(config.worldsFile, "utf-8")) : {};
-    deploys[chainId] = {
-      address: deploymentInfo.worldAddress,
-      // We expect the worlds file to be committed and since local deployments are often
-      // a consistent address but different block number, we'll ignore the block number.
-      blockNumber: localChains.includes(chainId) ? undefined : deploymentInfo.blockNumber,
-    };
-    writeFileSync(config.worldsFile, JSON.stringify(deploys, null, 2));
-
-    console.log(
-      chalk.bgGreen(chalk.whiteBright(`\n Deployment result (written to ${config.worldsFile} and ${deploysDir}): \n`)),
-    );
+    writeDeploymentResult({ client, config: configV2, deploymentInfo });
   }
 
   console.log(deploymentInfo);

packages/cli/src/utils/writeDeploymentResult.ts

@@ -0,0 +1,44 @@
+import { World as WorldConfig } from "@latticexyz/world";
+import { existsSync, mkdirSync, readFileSync, writeFileSync } from "fs";
+import path from "path";
+import { WalletClient } from "viem";
+import { getChainId } from "viem/actions";
+import chalk from "chalk";
+
+const localChains = [1337, 31337];
+
+export async function writeDeploymentResult({
+  client,
+  config,
+  deploymentInfo,
+}: {
+  client: WalletClient;
+  config: WorldConfig;
+  deploymentInfo: {
+    worldAddress: `0x${string}`;
+    blockNumber: number;
+  };
+}) {
+  const chainId = await getChainId(client);
+  const deploysDir = path.join(config.deploy.deploysDirectory, chainId.toString());
+  mkdirSync(deploysDir, { recursive: true });
+  writeFileSync(path.join(deploysDir, "latest.json"), JSON.stringify(deploymentInfo, null, 2));
+  writeFileSync(path.join(deploysDir, Date.now() + ".json"), JSON.stringify(deploymentInfo, null, 2));
+
+  const deploys = existsSync(config.deploy.worldsFile)
+    ? JSON.parse(readFileSync(config.deploy.worldsFile, "utf-8"))
+    : {};
+  deploys[chainId] = {
+    address: deploymentInfo.worldAddress,
+    // We expect the worlds file to be committed and since local deployments are often
+    // a consistent address but different block number, we'll ignore the block number.
+    blockNumber: localChains.includes(chainId) ? undefined : deploymentInfo.blockNumber,
+  };
+  writeFileSync(config.deploy.worldsFile, JSON.stringify(deploys, null, 2));
+
+  console.log(
+    chalk.bgGreen(
+      chalk.whiteBright(`\n Deployment result (written to ${config.deploy.worldsFile} and ${deploysDir}): \n`),
+    ),
+  );
+}