@latticexyz/cli 2.0.0-alpha.49 → 2.0.0-alpha.5

package/dist/mud2.d.ts

@@ -0,0 +1 @@
+#!/usr/bin/env node

package/dist/mud2.js

@@ -0,0 +1,25 @@
+#!/usr/bin/env node
+import {
+  commands
+} from "./chunk-KJTPZOUH.js";
+import {
+  logError
+} from "./chunk-YL4GJLLL.js";
+import "./chunk-VQTZJIFF.js";
+import "./chunk-FPG73MVN.js";
+import "./chunk-WZFXLDPK.js";
+import "./chunk-6V563IAZ.js";
+import "./chunk-SKNB74MT.js";
+import "./chunk-L4YLJHLJ.js";
+
+// src/mud2.ts
+import yargs from "yargs";
+import { hideBin } from "yargs/helpers";
+import * as dotenv from "dotenv";
+dotenv.config();
+yargs(hideBin(process.argv)).scriptName("mud").command(commands).strict().fail((msg, err) => {
+  console.log("");
+  logError(err);
+  console.log("");
+  process.exit(1);
+}).alias({ h: "help" }).argv;

package/dist/render-solidity/index.d.ts

@@ -1,6 +1,5 @@
-import { a as StoreConfig } from '../parseStoreConfig-899f574e.js';
+import { StoreConfig } from '@latticexyz/config';
 import { SchemaType } from '@latticexyz/schema-type';
-import 'zod';
 
 interface RenderTableOptions {
     /** List of symbols to import, and their file paths */
@@ -31,7 +30,7 @@ interface StaticResourceData {
     /** Name of the table id constant to render. */
     tableIdName: string;
     namespace: string;
-    fileSelector: string;
+    name: string;
 }
 interface RenderTableType {
     typeId: string;
@@ -87,6 +86,7 @@ interface RenderSystemInterfaceOptions {
 interface RenderSystemInterfaceFunction {
     name: string;
     parameters: string[];
+    stateMutability: string;
     returnParameters: string[];
 }
 interface RenderWorldOptions {

package/dist/render-solidity/index.js

@@ -16,15 +16,14 @@ import {
   renderedSolidityHeader,
   solidityRelativeImportPath,
   tablegen
-} from "../chunk-MXDV47JM.js";
+} from "../chunk-WZFXLDPK.js";
 import {
   getSchemaTypeInfo,
   getUserTypeInfo,
   importForAbiOrUserType,
   resolveAbiOrUserType
-} from "../chunk-5NC2OON2.js";
-import "../chunk-KPBNUPK6.js";
-import "../chunk-O6HOO6WA.js";
+} from "../chunk-SKNB74MT.js";
+import "../chunk-L4YLJHLJ.js";
 export {
   getSchemaTypeInfo,
   getTableOptions,

package/dist/render-ts/index.d.ts

@@ -1,6 +1,5 @@
-import { a as StoreConfig } from '../parseStoreConfig-899f574e.js';
+import { StoreConfig } from '@latticexyz/config';
 import { SchemaType } from '@latticexyz/schema-type';
-import 'zod';
 
 interface RecsV1TableOptions {
     tables: {
@@ -11,7 +10,7 @@ interface RecsV1TableOptions {
         }[];
         staticResourceData: {
             namespace: string;
-            fileSelector: string;
+            name: string;
         };
     }[];
 }

package/dist/render-ts/index.js

@@ -3,10 +3,9 @@ import {
   renderRecsV1Tables,
   schemaTypesToRecsTypeStrings,
   tsgen
-} from "../chunk-7GA2K5A6.js";
-import "../chunk-5NC2OON2.js";
-import "../chunk-KPBNUPK6.js";
-import "../chunk-O6HOO6WA.js";
+} from "../chunk-6V563IAZ.js";
+import "../chunk-SKNB74MT.js";
+import "../chunk-L4YLJHLJ.js";
 export {
   getRecsV1TableOptions,
   renderRecsV1Tables,

package/dist/utils/deprecated/index.js

@@ -14,9 +14,9 @@ import {
   hsr,
   keccak256,
   resetLibDeploy
-} from "../../chunk-SLIMIO4Z.js";
-import "../../chunk-ATAWDHWC.js";
-import "../../chunk-O6HOO6WA.js";
+} from "../../chunk-VQTZJIFF.js";
+import "../../chunk-FPG73MVN.js";
+import "../../chunk-L4YLJHLJ.js";
 export {
   IDregex,
   deploy,

package/dist/utils/index.d.ts

@@ -1,22 +1,5 @@
-import { ZodError, z } from 'zod';
-import { ValidationError } from 'zod-validation-error';
-import { MUDConfig } from '../config/index.js';
-import '../parseStoreConfig-899f574e.js';
-import '@latticexyz/schema-type';
+import { MUDConfig } from '@latticexyz/config';
 
-declare function fromZodErrorCustom(error: ZodError, prefix: string): ValidationError;
-declare class NotInsideProjectError extends Error {
-    name: string;
-    message: string;
-}
-declare class NotESMConfigError extends Error {
-    name: string;
-    message: string;
-}
-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 {
@@ -75,6 +58,12 @@ declare function forge(args: string[], options?: {
 declare function cast(args: string[], options?: {
     profile?: string;
 }): Promise<string>;
+/**
+ * Start an anvil chain
+ * @param args The arguments to pass to anvil
+ * @returns Stdout of the command
+ */
+declare function anvil(args: string[]): Promise<string>;
 
 declare function formatSolidity(content: string, prettierConfigPath?: string): Promise<string>;
 declare function formatTypescript(content: string): Promise<string>;
@@ -88,6 +77,7 @@ interface DeployConfig {
     privateKey: string;
     priorityFeeMultiplier: number;
     debug?: boolean;
+    worldAddress?: string;
 }
 interface DeploymentInfo {
     blockNumber: number;
@@ -95,4 +85,4 @@ interface DeploymentInfo {
 }
 declare function deploy(mudConfig: MUDConfig, deployConfig: DeployConfig): Promise<DeploymentInfo>;
 
-export { DeployConfig, DeploymentInfo, ForgeConfig, MUDError, NotESMConfigError, NotInsideProjectError, UnrecognizedSystemErrorFactory, cast, deploy, forge, formatAndWriteSolidity, formatAndWriteTypescript, formatSolidity, formatTypescript, fromZodErrorCustom, getForgeConfig, getOutDirectory, getRpcUrl, getScriptDirectory, getSrcDirectory, getTestDirectory, logError };
+export { DeployConfig, DeploymentInfo, ForgeConfig, anvil, cast, deploy, forge, formatAndWriteSolidity, formatAndWriteTypescript, formatSolidity, formatTypescript, getForgeConfig, getOutDirectory, getRpcUrl, getScriptDirectory, getSrcDirectory, getTestDirectory, logError };

package/dist/utils/index.js

@@ -1,15 +1,9 @@
 import {
-  deploy
-} from "../chunk-Q7D3SKYJ.js";
-import {
-  MUDError,
-  NotESMConfigError,
-  NotInsideProjectError,
-  UnrecognizedSystemErrorFactory,
-  fromZodErrorCustom,
+  deploy,
   logError
-} from "../chunk-LPWKZQUI.js";
+} from "../chunk-YL4GJLLL.js";
 import {
+  anvil,
   cast,
   forge,
   getForgeConfig,
@@ -18,20 +12,16 @@ import {
   getScriptDirectory,
   getSrcDirectory,
   getTestDirectory
-} from "../chunk-ATAWDHWC.js";
+} from "../chunk-FPG73MVN.js";
 import {
   formatAndWriteSolidity,
   formatAndWriteTypescript,
   formatSolidity,
   formatTypescript
-} from "../chunk-5NC2OON2.js";
-import "../chunk-KPBNUPK6.js";
-import "../chunk-O6HOO6WA.js";
+} from "../chunk-SKNB74MT.js";
+import "../chunk-L4YLJHLJ.js";
 export {
-  MUDError,
-  NotESMConfigError,
-  NotInsideProjectError,
-  UnrecognizedSystemErrorFactory,
+  anvil,
   cast,
   deploy,
   forge,
@@ -39,7 +29,6 @@ export {
   formatAndWriteTypescript,
   formatSolidity,
   formatTypescript,
-  fromZodErrorCustom,
   getForgeConfig,
   getOutDirectory,
   getRpcUrl,

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "@latticexyz/cli",
-  "version": "2.0.0-alpha.49+7d06c1b5",
+  "version": "2.0.0-alpha.5+01167ab3",
   "description": "Command line interface for mud",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "type": "module",
   "license": "MIT",
   "bin": {
-    "mud": "./dist/mud.js"
+    "mud": "./dist/mud.js",
+    "mud2": "./dist/mud2.js"
   },
   "repository": {
     "type": "git",
@@ -15,37 +16,38 @@
     "directory": "packages/cli"
   },
   "scripts": {
-    "prepare": "yarn build && chmod u+x git-install.sh",
-    "codegen": "ts-node --esm --files ./scripts/codegen.ts",
+    "codegen": "tsx ./scripts/codegen.ts",
     "lint": "eslint . --ext .ts",
     "dev": "tsup --watch",
     "build": "tsup",
-    "link": "yarn link",
-    "test": "vitest typecheck --run && yarn test:contracts",
-    "test:contracts": "yarn codegen && forge test",
-    "git:install": "bash git-install.sh",
+    "test": "tsc --noEmit && pnpm test:contracts",
+    "test:contracts": "pnpm codegen && forge test",
     "release": "npm publish --access=public"
   },
   "devDependencies": {
-    "@latticexyz/store": "^2.0.0-alpha.49+7d06c1b5",
     "@types/ejs": "^3.1.1",
     "@types/glob": "^7.2.0",
     "@types/node": "^17.0.34",
     "@types/openurl": "^1.0.0",
     "@types/yargs": "^17.0.10",
-    "esbuild": "^0.15.16",
     "tsup": "^6.6.3",
+    "tsx": "^3.12.6",
     "vitest": "^0.29.8"
   },
   "dependencies": {
+    "@ethersproject/abi": "^5.7.0",
+    "@ethersproject/providers": "^5.7.2",
     "@improbable-eng/grpc-web": "^0.15.0",
     "@improbable-eng/grpc-web-node-http-transport": "^0.15.0",
-    "@latticexyz/schema-type": "^2.0.0-alpha.49+7d06c1b5",
-    "@latticexyz/services": "^2.0.0-alpha.49+7d06c1b5",
-    "@latticexyz/solecs": "^2.0.0-alpha.49+7d06c1b5",
-    "@latticexyz/std-contracts": "^2.0.0-alpha.49+7d06c1b5",
+    "@latticexyz/config": "2.0.0-alpha.5+01167ab3",
+    "@latticexyz/schema-type": "2.0.0-alpha.5+01167ab3",
+    "@latticexyz/services": "2.0.0-alpha.5+01167ab3",
+    "@latticexyz/solecs": "2.0.0-alpha.5+01167ab3",
+    "@latticexyz/std-contracts": "2.0.0-alpha.5+01167ab3",
+    "@latticexyz/store": "2.0.0-alpha.5+01167ab3",
+    "@latticexyz/world": "2.0.0-alpha.5+01167ab3",
     "@solidity-parser/parser": "^0.16.0",
-    "@typechain/ethers-v5": "^10.1.1",
+    "@typechain/ethers-v5": "^10.2.0",
     "chalk": "^5.0.1",
     "chokidar": "^3.5.3",
     "dotenv": "^16.0.3",
@@ -53,7 +55,6 @@
     "ejs": "^3.1.8",
     "ethers": "^5.7.2",
     "execa": "^7.0.0",
-    "find-up": "^6.3.0",
     "forge-std": "https://github.com/foundry-rs/forge-std.git#b4f121555729b3afb3c5ffccb62ff4b6e2818fd3",
     "glob": "^8.0.3",
     "nice-grpc-web": "^2.0.1",
@@ -61,14 +62,12 @@
     "path": "^0.12.7",
     "prettier": "^2.8.4",
     "prettier-plugin-solidity": "^1.1.2",
-    "solmate": "https://github.com/Rari-Capital/solmate.git#9cf1428245074e39090dceacb0c28b1f684f584c",
     "table": "^6.8.1",
-    "ts-node": "^10.9.1",
     "typechain": "^8.1.1",
     "typescript": "^4.9.5",
     "yargs": "^17.7.1",
     "zod": "^3.21.4",
-    "zod-validation-error": "^1.0.1"
+    "zod-validation-error": "^1.3.0"
   },
-  "gitHead": "7d06c1b5cf00df627000c907e78f60d3cd2415cd"
+  "gitHead": "01167ab366c9e677fd84161401c07e44066f5f03"
 }

package/src/commands/deploy-v2.ts

@@ -1,80 +1,81 @@
 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 type { CommandModule, Options } from "yargs";
+import { loadStoreConfig, loadWorldConfig } from "@latticexyz/config";
+import { MUDError } from "@latticexyz/config";
 import { deploy } from "../utils/deploy-v2.js";
-import { logError, MUDError } from "../utils/errors.js";
+import { logError } 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 = {
+export type DeployOptions = {
   configPath?: string;
   printConfig?: boolean;
   profile?: string;
-  privateKey: string;
   priorityFeeMultiplier: number;
   clean?: boolean;
   debug?: boolean;
+  saveDeployment?: boolean;
+  rpc?: string;
+  worldAddress?: string;
+  srcDir?: string;
 };
 
-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,
-      },
-    });
+export const yDeployOptions = {
+  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 });
-
+  saveDeployment: { type: "boolean", desc: "Save the deployment info to a file", default: true },
+  rpc: { type: "string", desc: "The RPC URL to use. Defaults to the RPC url from the local foundry.toml" },
+  worldAddress: { type: "string", desc: "Deploy to an existing World at the given address" },
+  srcDir: { type: "string", desc: "Source directory. Defaults to foundry src directory." },
+} satisfies Record<keyof DeployOptions, Options>;
+
+export async function deployHandler(args: Parameters<(typeof commandModule)["handler"]>[0]) {
+  args.profile = args.profile ?? process.env.FOUNDRY_PROFILE;
+  const { configPath, printConfig, profile, clean } = args;
+
+  const rpc = args.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 = args?.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 });
+
+    if (args.saveDeployment) {
       // Write deployment result to file (latest and timestamp)
       const chainId = await getChainId(rpc);
       const outputDir = path.join(mudConfig.deploysDirectory, chainId.toString());
@@ -83,12 +84,27 @@ const commandModule: CommandModule<Options, Options> = {
       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);
     }
 
+    console.log(deploymentInfo);
+    return deploymentInfo;
+  } catch (error: any) {
+    logError(error);
+    process.exit(1);
+  }
+}
+
+const commandModule: CommandModule<DeployOptions, DeployOptions> = {
+  command: "deploy-v2",
+
+  describe: "Deploy MUD v2 contracts",
+
+  builder(yargs) {
+    return yargs.options(yDeployOptions);
+  },
+
+  async handler(args) {
+    await deployHandler(args);
     process.exit(0);
   },
 };

package/src/commands/deprecated/index.ts

@@ -0,0 +1,22 @@
+import { CommandModule } from "yargs";
+
+import bulkupload from "./bulkupload.js";
+import callSystem from "./call-system.js";
+import codegenLibdeploy from "./codegen-libdeploy.js";
+import deployContracts from "./deploy-contracts.js";
+import systemTypes from "./system-types.js";
+import test from "./test.js";
+import trace from "./trace.js";
+import types from "./types.js";
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any -- Each command has different options
+export const commands: CommandModule<any, any>[] = [
+  bulkupload,
+  callSystem,
+  deployContracts,
+  codegenLibdeploy,
+  systemTypes,
+  test,
+  trace,
+  types,
+];

package/src/commands/deprecated/test.ts

@@ -43,7 +43,7 @@ const commandModule: CommandModule<Options, Options> = {
     });
 
     await child;
-    
+
     // Reset LibDeploy.sol
     console.log("Reset LibDeploy.sol");
     await resetLibDeploy(testDir);