@latticexyz/cli 1.40.0 → 2.0.0-alpha.0

package/dist/utils/deprecated/index.js

@@ -14,8 +14,8 @@ import {
   hsr,
   keccak256,
   resetLibDeploy
-} from "../../chunk-S3V3XX7N.js";
-import "../../chunk-PJ6GS2R4.js";
+} from "../../chunk-SLIMIO4Z.js";
+import "../../chunk-ATAWDHWC.js";
 import "../../chunk-O6HOO6WA.js";
 export {
   IDregex,

package/dist/utils/index.d.ts

@@ -1,5 +1,7 @@
-import { ZodError } from 'zod';
+import { ZodError, z } from 'zod';
 import { ValidationError } from 'zod-validation-error';
+import { MUDConfig } from '../config/index.js';
+import '@latticexyz/schema-type';
 
 declare function fromZodErrorCustom(error: ZodError, prefix: string): ValidationError;
 declare class NotInsideProjectError extends Error {
@@ -10,35 +12,82 @@ declare class NotESMConfigError extends Error {
     name: string;
     message: string;
 }
-declare function logError(error: Error): void;
+declare class MUDError extends Error {
+    name: string;
+}
+declare function UnrecognizedSystemErrorFactory(path: string[], systemName: string): z.ZodError<any>;
+declare function logError(error: unknown): void;
 
 interface ForgeConfig {
     src: string;
     test: string;
+    script: string;
     out: string;
     libs: string[];
+    eth_rpc_url: string | null;
     [key: string]: unknown;
 }
 /**
  * Get forge config as a parsed json object.
  */
-declare function getForgeConfig(): Promise<ForgeConfig>;
+declare function getForgeConfig(profile?: string): Promise<ForgeConfig>;
 /**
  * Get the value of "src" from forge config.
  * The path to the contract sources relative to the root of the project.
  */
-declare function getSrcDirectory(): Promise<string>;
+declare function getSrcDirectory(profile?: string): Promise<string>;
+/**
+ * Get the value of "script" from forge config.
+ * The path to the contract sources relative to the root of the project.
+ */
+declare function getScriptDirectory(profile?: string): Promise<string>;
 /**
  * Get the value of "test" from forge config.
  * The path to the test contract sources relative to the root of the project.
  */
-declare function getTestDirectory(): Promise<string>;
+declare function getTestDirectory(profile?: string): Promise<string>;
 /**
  * Get the value of "out" from forge config.
  * The path to put contract artifacts in, relative to the root of the project.
  */
-declare function getOutDirectory(): Promise<string>;
+declare function getOutDirectory(profile?: string): Promise<string>;
+/**
+ * Get the value of "eth_rpc_url" from forge config, default to "http://127.0.0.1:8545"
+ * @param profile The foundry profile to use
+ * @returns The rpc url
+ */
+declare function getRpcUrl(profile?: string): Promise<string>;
+/**
+ * Execute a forge command
+ * @param args The arguments to pass to forge
+ * @param options { profile?: The foundry profile to use; silent?: If true, nothing will be logged to the console }
+ */
+declare function forge(args: string[], options?: {
+    profile?: string;
+    silent?: boolean;
+}): Promise<void>;
+/**
+ * Execute a cast command
+ * @param args The arguments to pass to cast
+ * @returns Stdout of the command
+ */
+declare function cast(args: string[], options?: {
+    profile?: string;
+}): Promise<string>;
 
 declare function formatSolidity(content: string, prettierConfigPath?: string): Promise<string>;
 
-export { ForgeConfig, NotESMConfigError, NotInsideProjectError, formatSolidity, fromZodErrorCustom, getForgeConfig, getOutDirectory, getSrcDirectory, getTestDirectory, logError };
+interface DeployConfig {
+    profile?: string;
+    rpc: string;
+    privateKey: string;
+    priorityFeeMultiplier: number;
+    debug?: boolean;
+}
+interface DeploymentInfo {
+    blockNumber: number;
+    worldAddress: string;
+}
+declare function deploy(mudConfig: MUDConfig, deployConfig: DeployConfig): Promise<DeploymentInfo>;
+
+export { DeployConfig, DeploymentInfo, ForgeConfig, MUDError, NotESMConfigError, NotInsideProjectError, UnrecognizedSystemErrorFactory, cast, deploy, forge, formatSolidity, fromZodErrorCustom, getForgeConfig, getOutDirectory, getRpcUrl, getScriptDirectory, getSrcDirectory, getTestDirectory, logError };

package/dist/utils/index.js

@@ -1,26 +1,40 @@
 import {
+  deploy,
   formatSolidity
-} from "../chunk-UC3QPOON.js";
+} from "../chunk-O57QENJ6.js";
 import {
+  MUDError,
   NotESMConfigError,
   NotInsideProjectError,
+  UnrecognizedSystemErrorFactory,
   fromZodErrorCustom,
   logError
-} from "../chunk-JKAA3WMC.js";
+} from "../chunk-J4DJQNIC.js";
 import {
+  cast,
+  forge,
   getForgeConfig,
   getOutDirectory,
+  getRpcUrl,
+  getScriptDirectory,
   getSrcDirectory,
   getTestDirectory
-} from "../chunk-PJ6GS2R4.js";
+} from "../chunk-ATAWDHWC.js";
 import "../chunk-O6HOO6WA.js";
 export {
+  MUDError,
   NotESMConfigError,
   NotInsideProjectError,
+  UnrecognizedSystemErrorFactory,
+  cast,
+  deploy,
+  forge,
   formatSolidity,
   fromZodErrorCustom,
   getForgeConfig,
   getOutDirectory,
+  getRpcUrl,
+  getScriptDirectory,
   getSrcDirectory,
   getTestDirectory,
   logError

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@latticexyz/cli",
-  "version": "1.40.0",
+  "version": "2.0.0-alpha.0",
   "description": "Command line interface for mud",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -16,15 +16,18 @@
   },
   "scripts": {
     "prepare": "yarn build && chmod u+x git-install.sh",
+    "codegen": "ts-node --esm --files ./scripts/codegen.ts",
     "lint": "eslint . --ext .ts",
     "dev": "tsup --watch",
     "build": "tsup",
     "link": "yarn link",
-    "test": "vitest typecheck --run && echo 'todo: add tests'",
+    "test": "vitest typecheck --run && yarn test:contracts",
+    "test:contracts": "yarn codegen && forge test",
     "git:install": "bash git-install.sh",
-    "release": "npm publish || echo 'version already published'"
+    "release": "npm publish --access=public"
   },
   "devDependencies": {
+    "@latticexyz/store": "^2.0.0-alpha.0",
     "@types/ejs": "^3.1.1",
     "@types/glob": "^7.2.0",
     "@types/node": "^17.0.34",
@@ -37,17 +40,19 @@
   "dependencies": {
     "@improbable-eng/grpc-web": "^0.15.0",
     "@improbable-eng/grpc-web-node-http-transport": "^0.15.0",
-    "@latticexyz/schema-type": "^1.40.0",
-    "@latticexyz/services": "^1.40.0",
-    "@latticexyz/solecs": "^1.40.0",
-    "@latticexyz/std-contracts": "^1.40.0",
+    "@latticexyz/schema-type": "^2.0.0-alpha.0",
+    "@latticexyz/services": "^2.0.0-alpha.0",
+    "@latticexyz/solecs": "^2.0.0-alpha.0",
+    "@latticexyz/std-contracts": "^2.0.0-alpha.0",
+    "@solidity-parser/parser": "^0.16.0",
     "@typechain/ethers-v5": "^10.1.1",
     "chalk": "^5.0.1",
     "chokidar": "^3.5.3",
+    "dotenv": "^16.0.3",
     "ds-test": "https://github.com/dapphub/ds-test.git#c9ce3f25bde29fc5eb9901842bf02850dfd2d084",
     "ejs": "^3.1.8",
     "ethers": "^5.7.2",
-    "execa": "^6.1.0",
+    "execa": "^7.0.0",
     "find-up": "^6.3.0",
     "forge-std": "https://github.com/foundry-rs/forge-std.git#b4f121555729b3afb3c5ffccb62ff4b6e2818fd3",
     "glob": "^8.0.3",
@@ -62,8 +67,8 @@
     "typechain": "^8.1.1",
     "typescript": "^4.9.5",
     "yargs": "^17.7.1",
-    "zod": "^3.20.6",
-    "zod-validation-error": "^0.3.2"
+    "zod": "^3.21.4",
+    "zod-validation-error": "^1.0.1"
   },
-  "gitHead": "914a1e0ae4a573d685841ca2ea921435057deb8f"
+  "gitHead": "fcb2166c25edd27ead54f0afa1b71d2583939603"
 }

package/src/commands/deploy-v2.ts

@@ -0,0 +1,96 @@
+import chalk from "chalk";
+import glob from "glob";
+import path, { basename } from "path";
+import type { CommandModule } from "yargs";
+import { loadWorldConfig } from "../config/world/index.js";
+import { deploy } from "../utils/deploy-v2.js";
+import { logError, MUDError } from "../utils/errors.js";
+import { forge, getRpcUrl, getSrcDirectory } from "../utils/foundry.js";
+import { mkdirSync, writeFileSync } from "fs";
+import { loadStoreConfig } from "../config/loadStoreConfig.js";
+import { getChainId } from "../utils/getChainId.js";
+
+type Options = {
+  configPath?: string;
+  printConfig?: boolean;
+  profile?: string;
+  privateKey: string;
+  priorityFeeMultiplier: number;
+  clean?: boolean;
+  debug?: boolean;
+};
+
+const commandModule: CommandModule<Options, Options> = {
+  command: "deploy-v2",
+
+  describe: "Deploy MUD v2 contracts",
+
+  builder(yargs) {
+    return yargs.options({
+      configPath: { type: "string", desc: "Path to the config file" },
+      clean: { type: "boolean", desc: "Remove the build forge artifacts and cache directories before building" },
+      printConfig: { type: "boolean", desc: "Print the resolved config" },
+      profile: { type: "string", desc: "The foundry profile to use" },
+      debug: { type: "boolean", desc: "Print debug logs, like full error messages" },
+      priorityFeeMultiplier: {
+        type: "number",
+        desc: "Multiply the estimated priority fee by the provided factor",
+        default: 1,
+      },
+    });
+  },
+
+  async handler(args) {
+    args.profile = args.profile ?? process.env.FOUNDRY_PROFILE;
+    const { configPath, printConfig, profile, clean } = args;
+
+    const rpc = await getRpcUrl(profile);
+    console.log(
+      chalk.bgBlue(
+        chalk.whiteBright(`\n Deploying MUD v2 contracts${profile ? " with profile " + profile : ""} to RPC ${rpc} \n`)
+      )
+    );
+
+    if (clean) await forge(["clean"], { profile });
+
+    // Run forge build
+    await forge(["build"], { profile });
+
+    // Get a list of all contract names
+    const srcDir = await getSrcDirectory();
+    const existingContracts = glob
+      .sync(`${srcDir}/**/*.sol`)
+      // Get the basename of the file
+      .map((path) => basename(path, ".sol"));
+
+    // Load and resolve the config
+    const worldConfig = await loadWorldConfig(configPath, existingContracts);
+    const storeConfig = await loadStoreConfig(configPath);
+    const mudConfig = { ...worldConfig, ...storeConfig };
+
+    if (printConfig) console.log(chalk.green("\nResolved config:\n"), JSON.stringify(mudConfig, null, 2));
+
+    try {
+      const privateKey = process.env.PRIVATE_KEY;
+      if (!privateKey) throw new MUDError("Missing PRIVATE_KEY environment variable");
+      const deploymentInfo = await deploy(mudConfig, { ...args, rpc, privateKey });
+
+      // Write deployment result to file (latest and timestamp)
+      const chainId = await getChainId(rpc);
+      const outputDir = path.join(mudConfig.deploysDirectory, chainId.toString());
+      mkdirSync(outputDir, { recursive: true });
+      writeFileSync(path.join(outputDir, "latest.json"), JSON.stringify(deploymentInfo, null, 2));
+      writeFileSync(path.join(outputDir, Date.now() + ".json"), JSON.stringify(deploymentInfo, null, 2));
+
+      console.log(chalk.bgGreen(chalk.whiteBright(`\n Deployment result (written to ${outputDir}): \n`)));
+      console.log(deploymentInfo);
+    } catch (error: any) {
+      logError(error);
+      process.exit(1);
+    }
+
+    process.exit(0);
+  },
+};
+
+export default commandModule;

package/src/commands/deprecated/call-system.ts

@@ -2,7 +2,7 @@ import { defaultAbiCoder as abi } from "ethers/lib/utils.js";
 import path from "path";
 import type { CommandModule } from "yargs";
 import { execLog } from "../../utils/deprecated/index.js";
-import { getTestDirectory } from "../../utils/forgeConfig.js";
+import { getTestDirectory } from "../../utils/foundry.js";
 
 type Options = {
   rpc?: string;

package/src/commands/deprecated/deploy-contracts.ts

@@ -2,7 +2,7 @@ import type { CommandModule } from "yargs";
 import { DeployOptions, generateAndDeploy, hsr } from "../../utils/deprecated/index.js";
 import openurl from "openurl";
 import chalk from "chalk";
-import { getSrcDirectory } from "../../utils/forgeConfig.js";
+import { getSrcDirectory } from "../../utils/foundry.js";
 
 type Options = DeployOptions & {
   watch?: boolean;

package/src/commands/deprecated/test.ts

@@ -1,6 +1,6 @@
 import type { CommandModule } from "yargs";
 import { execLog, generateLibDeploy, resetLibDeploy } from "../../utils/deprecated/index.js";
-import { getTestDirectory } from "../../utils/forgeConfig.js";
+import { getTestDirectory } from "../../utils/foundry.js";
 
 type Options = {
   forgeOpts?: string;
@@ -35,15 +35,18 @@ const commandModule: CommandModule<Options, Options> = {
       ...(forgeOpts?.split(" ") || []),
     ]);
 
-    // Reset LibDeploy.sol
-    console.log("Reset LibDeploy.sol");
-    await resetLibDeploy(testDir);
-
-    process.on("SIGINT", () => {
+    process.on("SIGINT", async () => {
       console.log("\ngracefully shutting down from SIGINT (Crtl-C)");
       child.kill();
+      await resetLibDeploy(testDir);
       process.exit();
     });
+
+    await child;
+    
+    // Reset LibDeploy.sol
+    console.log("Reset LibDeploy.sol");
+    await resetLibDeploy(testDir);
   },
 };
 

package/src/commands/deprecated/trace.ts

@@ -4,7 +4,7 @@ import { readFileSync } from "fs";
 import { Contract } from "ethers";
 import { JsonRpcProvider } from "@ethersproject/providers";
 import WorldAbi from "@latticexyz/solecs/abi/World.json" assert { type: "json" };
-import { getSrcDirectory } from "../../utils/forgeConfig.js";
+import { getSrcDirectory } from "../../utils/foundry.js";
 import path from "path";
 import { componentsDir, systemsDir } from "../../utils/deprecated/constants.js";
 

package/src/commands/gas-report.ts

@@ -156,7 +156,7 @@ console.log("GAS REPORT: ${name} [${functionCall.replaceAll('"', '\\"')}]:", _ga
     stdio: ["inherit", "pipe", "inherit"],
   });
 
-  // Extrect the logs from the child process
+  // Extract the logs from the child process
   let logs = "";
   try {
     logs = (await child).stdout;

package/src/commands/index.ts

@@ -14,6 +14,8 @@ import faucet from "./faucet.js";
 import gasReport from "./gas-report.js";
 import hello from "./hello.js";
 import tablegen from "./tablegen.js";
+import deployV2 from "./deploy-v2.js";
+import worldgen from "./worldgen.js";
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any -- Each command has different options
 export const commands: CommandModule<any, any>[] = [
@@ -21,6 +23,7 @@ export const commands: CommandModule<any, any>[] = [
   callSystem,
   codegenLibdeploy,
   deployContracts,
+  deployV2,
   devnode,
   faucet,
   gasReport,
@@ -30,4 +33,5 @@ export const commands: CommandModule<any, any>[] = [
   test,
   trace,
   types,
+  worldgen,
 ];

package/src/commands/tablegen.ts

@@ -1,10 +1,7 @@
 import type { CommandModule } from "yargs";
-import { mkdirSync, writeFileSync } from "fs";
-import path from "path";
 import { loadStoreConfig } from "../config/loadStoreConfig.js";
-import { renderTablesFromConfig } from "../render-table/renderTablesFromConfig.js";
-import { getSrcDirectory } from "../utils/forgeConfig.js";
-import { formatSolidity } from "../utils/format.js";
+import { getSrcDirectory } from "../utils/foundry.js";
+import { tablegen } from "../render-solidity/tablegen.js";
 
 type Options = {
   configPath?: string;
@@ -22,22 +19,11 @@ const commandModule: CommandModule<Options, Options> = {
   },
 
   async handler({ configPath }) {
-    const srcDir = await getSrcDirectory();
+    const srcDirectory = await getSrcDirectory();
 
     const config = await loadStoreConfig(configPath);
-    const renderedTables = renderTablesFromConfig(config);
 
-    for (const { output, tableName } of renderedTables) {
-      const formattedOutput = await formatSolidity(output);
-
-      const tablePath = config.tables[tableName].route;
-      const outputDirectory = path.join(srcDir, tablePath);
-      mkdirSync(outputDirectory, { recursive: true });
-
-      const outputPath = path.join(outputDirectory, `${tableName}.sol`);
-      writeFileSync(outputPath, formattedOutput);
-      console.log(`Generated schema: ${outputPath}`);
-    }
+    await tablegen(config, srcDirectory);
 
     process.exit(0);
   },

package/src/commands/worldgen.ts

@@ -0,0 +1,55 @@
+import type { CommandModule } from "yargs";
+import { loadStoreConfig } from "../config/loadStoreConfig.js";
+import { loadWorldConfig } from "../config/index.js";
+import { getSrcDirectory } from "../utils/foundry.js";
+import glob from "glob";
+import path, { basename } from "path";
+import { worldgen } from "../render-solidity/worldgen.js";
+import { rmSync } from "fs";
+
+type Options = {
+  configPath?: string;
+  clean?: boolean;
+};
+
+const commandModule: CommandModule<Options, Options> = {
+  command: "worldgen",
+
+  describe: "Autogenerate interfaces for Systems and World based on existing contracts and the config file",
+
+  builder(yargs) {
+    return yargs.options({
+      configPath: { type: "string", desc: "Path to the config file" },
+      clean: { type: "boolean", desc: "Clear the worldgen directory before generating new interfaces" },
+    });
+  },
+
+  async handler(args) {
+    const { configPath, clean } = args;
+    const srcDir = await getSrcDirectory();
+
+    // Get a list of all contract names
+    const existingContracts = glob.sync(`${srcDir}/**/*.sol`).map((path) => ({
+      path,
+      basename: basename(path, ".sol"),
+    }));
+
+    // Load and resolve the config
+    const worldConfig = await loadWorldConfig(
+      configPath,
+      existingContracts.map(({ basename }) => basename)
+    );
+    const storeConfig = await loadStoreConfig(configPath);
+    const mudConfig = { ...worldConfig, ...storeConfig };
+
+    // clear the worldgen directory
+    if (clean) rmSync(path.join(srcDir, worldConfig.worldgenDirectory), { recursive: true, force: true });
+
+    // generate new interfaces
+    await worldgen(mudConfig, existingContracts, srcDir);
+
+    process.exit(0);
+  },
+};
+
+export default commandModule;

package/src/config/commonSchemas.ts

@@ -2,19 +2,33 @@ import { z } from "zod";
 import {
   validateBaseRoute,
   validateCapitalizedName,
+  validateEthereumAddress,
+  validateEnum,
+  validateName,
   validateRoute,
   validateSingleLevelRoute,
   validateUncapitalizedName,
+  validateSelector,
 } from "./validation.js";
 
 /** Capitalized names of objects, like tables and systems */
-export const ObjectName = z.string().superRefine(validateCapitalizedName);
+export const zObjectName = z.string().superRefine(validateCapitalizedName);
 /** Uncapitalized names of values, like keys and columns */
-export const ValueName = z.string().superRefine(validateUncapitalizedName);
+export const zValueName = z.string().superRefine(validateUncapitalizedName);
+/** Name that can start with any case */
+export const zAnyCaseName = z.string().superRefine(validateName);
+/** List of unique enum member names and 0 < length < 256 */
+export const zUserEnum = z.array(zObjectName).superRefine(validateEnum);
 
 /** Ordinary routes */
-export const OrdinaryRoute = z.string().superRefine(validateRoute);
+export const zOrdinaryRoute = z.string().superRefine(validateRoute);
 /** Routes with exactly 1 non-empty level */
-export const SingleLevelRoute = z.string().superRefine(validateSingleLevelRoute);
+export const zSingleLevelRoute = z.string().superRefine(validateSingleLevelRoute);
 /** Base routes (can be an empty string) */
-export const BaseRoute = z.string().superRefine(validateBaseRoute);
+export const zBaseRoute = z.string().superRefine(validateBaseRoute);
+
+/** A valid Ethereum address */
+export const zEthereumAddress = z.string().superRefine(validateEthereumAddress);
+
+/** A selector for namespace/file/resource */
+export const zSelector = z.string().superRefine(validateSelector);

package/src/config/dynamicResolution.ts

@@ -0,0 +1,49 @@
+import { MUDError } from "../utils/errors.js";
+import { ValueWithType } from "./world/userTypes.js";
+
+export enum DynamicResolutionType {
+  TABLE_ID,
+  SYSTEM_ADDRESS,
+}
+
+export type DynamicResolution = {
+  type: DynamicResolutionType;
+  input: string;
+};
+
+/**
+ * Dynamically resolve a table name to a table id at deploy time
+ */
+export function resolveTableId(tableName: string) {
+  return {
+    type: DynamicResolutionType.TABLE_ID,
+    input: tableName,
+  };
+}
+
+/** Type guard for DynamicResolution */
+export function isDynamicResolution(value: unknown): value is DynamicResolution {
+  return typeof value === "object" && value !== null && "type" in value && "input" in value;
+}
+
+/**
+ * Turn a DynamicResolution object into a ValueWithType based on the provided context
+ */
+export async function resolveWithContext(
+  unresolved: any,
+  context: { systemAddresses?: Record<string, Promise<string>>; tableIds?: Record<string, Uint8Array> }
+): Promise<ValueWithType> {
+  if (!isDynamicResolution(unresolved)) return unresolved;
+  let resolved: ValueWithType | undefined = undefined;
+
+  if (unresolved.type === DynamicResolutionType.TABLE_ID) {
+    const tableId = context.tableIds?.[unresolved.input];
+    resolved = tableId && { value: tableId, type: "bytes32" };
+  }
+
+  if (resolved === undefined) {
+    throw new MUDError(`Could not resolve dynamic resolution: \n${JSON.stringify(unresolved, null, 2)}`);
+  }
+
+  return resolved;
+}

package/src/config/index.ts

@@ -1,4 +1,24 @@
+import { ExtractUserTypes, StringForUnion } from "../utils/typeUtils.js";
+import { StoreUserConfig, StoreConfig } from "./parseStoreConfig.js";
+import { WorldUserConfig, ResolvedWorldConfig } from "./world/index.js";
+
+export type MUDUserConfig<
+  EnumNames extends StringForUnion = StringForUnion,
+  StaticUserTypes extends ExtractUserTypes<EnumNames> = ExtractUserTypes<EnumNames>
+> = StoreUserConfig<EnumNames, StaticUserTypes> & WorldUserConfig;
+export type MUDConfig = StoreConfig & ResolvedWorldConfig;
+
+export function mudConfig<
+  EnumNames extends StringForUnion = never,
+  StaticUserTypes extends ExtractUserTypes<EnumNames> = ExtractUserTypes<EnumNames>
+>(config: MUDUserConfig<EnumNames, StaticUserTypes>) {
+  return config;
+}
+
 export * from "./commonSchemas.js";
 export * from "./loadConfig.js";
 export * from "./loadStoreConfig.js";
+export * from "./parseStoreConfig.js";
+export * from "./world/index.js";
 export * from "./validation.js";
+export * from "./dynamicResolution.js";