@latticexyz/cli 0.11.1 → 0.13.0

package/dist/commands/bulkupload.js

@@ -0,0 +1,45 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handler = exports.builder = exports.desc = exports.command = void 0;
+const importExeca = eval('import("execa")');
+exports.command = "bulkupload";
+exports.desc = "Uploads the provided ECS state to the provided World";
+const builder = (yargs) => yargs.options({
+    statePath: { type: "string", demandOption: true, desc: "Path to the ECS state to upload" },
+    worldAddress: { type: "string", demandOption: true, desc: "Contract address of the World to upload to" },
+    rpc: { type: "string", demandOption: true, desc: "JSON RPC endpoint" },
+});
+exports.builder = builder;
+const handler = (argv) => __awaiter(void 0, void 0, void 0, function* () {
+    const { execa } = yield importExeca;
+    const { statePath, worldAddress, rpc } = argv;
+    console.log("Uploading state at ", statePath, "to", worldAddress, "on", rpc);
+    const url = __dirname + "/../../src/contracts/BulkUpload.sol";
+    console.log("Using BulkUpload script from", url);
+    try {
+        yield execa("forge", [
+            "script",
+            "--sig",
+            '"run(string, address)"',
+            "--rpc-url",
+            rpc,
+            `${url}:BulkUpload`,
+            statePath,
+            worldAddress,
+        ]);
+    }
+    catch (e) {
+        console.error(e);
+    }
+    process.exit(0);
+});
+exports.handler = handler;

package/dist/commands/deploy.js

@@ -302,7 +302,7 @@ const deploy = (options) => __awaiter(void 0, void 0, void 0, function* () {
     const cmdArgs = options.upgradeSystems
         ? [
             "workspace",
-            "ri-contracts",
+            "contracts",
             "forge:deploy",
             ...(options.dry ? [] : ["--broadcast", "--private-keys", wallet.privateKey]),
             "--sig",
@@ -314,7 +314,7 @@ const deploy = (options) => __awaiter(void 0, void 0, void 0, function* () {
         ]
         : [
             "workspace",
-            "ri-contracts",
+            "contracts",
             "forge:deploy",
             ...(options.dry ? [] : ["--broadcast", "--private-keys", wallet.privateKey]),
             "--sig",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@latticexyz/cli",
-  "version": "0.11.1",
+  "version": "0.13.0",
   "description": "Command line interface for mud",
   "main": "dist/index.js",
   "license": "MIT",
@@ -13,11 +13,13 @@
     "directory": "packages/cli"
   },
   "scripts": {
-    "prepare": "yarn build",
-    "globalinstall": "yarn build && npm link",
+    "prepare": "yarn build && chmod u+x git-install.sh",
+    "globalinstall": "yarn prepare && npm link",
     "build": "rimraf dist && tsc -p . && chmod u+x dist/index.js",
     "link": "yarn link",
-    "test": "echo 'todo: add tests'"
+    "test": "echo 'todo: add tests'",
+    "git:install": "bash git-install.sh",
+    "release": "npm publish || echo 'version already published'"
   },
   "devDependencies": {
     "@types/clear": "^0.1.2",
@@ -34,15 +36,18 @@
     "typescript": "^4.6.4"
   },
   "dependencies": {
-    "@latticexyz/solecs": "^0.11.1",
-    "@latticexyz/utils": "^0.11.1",
+    "@latticexyz/solecs": "^0.13.0",
+    "@latticexyz/std-contracts": "^0.13.0",
+    "@latticexyz/utils": "^0.13.0",
     "chalk": "^5.0.1",
     "clear": "^0.1.0",
     "commander": "^9.2.0",
+    "ds-test": "https://github.com/dapphub/ds-test.git#9310e879db8ba3ea6d5c6489a579118fd264a3f5",
     "esm": "^3.2.25",
     "ethers": "^5.6.7",
     "execa": "^6.1.0",
     "figlet": "^1.5.2",
+    "forge-std": "https://github.com/foundry-rs/forge-std.git#6b4ca42943f093642bac31783b08aa52a5a6ff64",
     "glob": "^8.0.3",
     "inquirer": "^8.2.4",
     "inquirer-prompt-suggest": "^0.1.0",
@@ -51,6 +56,7 @@
     "node-fetch": "^3.2.6",
     "openurl": "^1.1.1",
     "path": "^0.12.7",
+    "solmate": "https://github.com/Rari-Capital/solmate.git#9cf1428245074e39090dceacb0c28b1f684f584c",
     "typechain": "^8.1.0",
     "uuid": "^8.3.2",
     "yargs": "^17.5.1"
@@ -58,5 +64,5 @@
   "pkg": {
     "scripts": "build/**/*.js"
   },
-  "gitHead": "43b26a1c0311605a3f91e630e57487a8e4faa58f"
+  "gitHead": "d4f7761040185d9d4b65c286e774e15fb8207f81"
 }

package/src/commands/bulkupload.ts

@@ -0,0 +1,44 @@
+import { Arguments, CommandBuilder } from "yargs";
+
+const importExeca = eval('import("execa")') as Promise<typeof import("execa")>;
+
+type Options = {
+  statePath: string;
+  worldAddress: string;
+  rpc: string;
+};
+
+export const command = "bulkupload";
+export const desc = "Uploads the provided ECS state to the provided World";
+
+export const builder: CommandBuilder<Options, Options> = (yargs) =>
+  yargs.options({
+    statePath: { type: "string", demandOption: true, desc: "Path to the ECS state to upload" },
+    worldAddress: { type: "string", demandOption: true, desc: "Contract address of the World to upload to" },
+    rpc: { type: "string", demandOption: true, desc: "JSON RPC endpoint" },
+  });
+
+export const handler = async (argv: Arguments<Options>): Promise<void> => {
+  const { execa } = await importExeca;
+  const { statePath, worldAddress, rpc } = argv;
+  console.log("Uploading state at ", statePath, "to", worldAddress, "on", rpc);
+  const url = __dirname + "/../../src/contracts/BulkUpload.sol";
+  console.log("Using BulkUpload script from", url);
+
+  try {
+    await execa("forge", [
+      "script",
+      "--sig",
+      '"run(string, address)"',
+      "--rpc-url",
+      rpc,
+      `${url}:BulkUpload`,
+      statePath,
+      worldAddress,
+    ]);
+  } catch (e) {
+    console.error(e);
+  }
+
+  process.exit(0);
+};

package/src/commands/call-system.ts

@@ -0,0 +1,62 @@
+import { defaultAbiCoder as abi } from "ethers/lib/utils";
+import { Arguments, CommandBuilder } from "yargs";
+import { execLog } from "../utils";
+
+type Options = {
+  rpc?: string;
+  caller?: string;
+  world: string;
+  systemId?: string;
+  systemAddress?: string;
+  argTypes?: any[];
+  args?: any[];
+  calldata?: string;
+  broadcast?: boolean;
+  callerPrivateKey?: string;
+  debug?: boolean;
+};
+
+export const command = "call-system";
+export const desc = "Execute a mud system";
+
+export const builder: CommandBuilder<Options, Options> = (yargs) =>
+  yargs.options({
+    rpc: { type: "string", description: "json rpc endpoint, defaults to http://localhost:8545" },
+    caller: { type: "string", description: "caller address" },
+    world: { type: "string", required: true, description: "world contract address" },
+    systemId: { type: "string", description: "system id preimage (eg mud.system.Move)" },
+    systemAddress: { type: "string", description: "system address (alternative to system id)" },
+    argTypes: { type: "array", description: "system argument types for abi encoding" },
+    args: { type: "array", description: "system arguments" },
+    calldata: { type: "string", description: "abi encoded system arguments (instead of args/argTypes)" },
+    broadcast: { type: "boolean", description: "send txs to the chain" },
+    callerPrivateKey: {
+      type: "string",
+      description: "must be set if broadcast is set, must correspond to caller address",
+    },
+    debug: { type: "boolean", description: "open debugger" },
+  });
+
+export const handler = async (argv: Arguments<Options>): Promise<void> => {
+  const { rpc, caller, world, systemId, argTypes, args, calldata, broadcast, callerPrivateKey, debug } = argv;
+  const encodedArgs = calldata ?? (argTypes && args && abi.encode(argTypes, args)) ?? "";
+  await execLog("forge", [
+    "script",
+    "--fork-url",
+    rpc ?? "http://localhost:8545", // default anvil rpc
+    "--sig",
+    "debug(address,address,string,bytes,bool)",
+    "src/test/utils/Debug.sol", // the cli expects the Debug.sol file at this path
+    caller ?? "0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266", // default anvil deployer
+    world,
+    systemId || "",
+    encodedArgs,
+    broadcast ? "true" : "false",
+    "-vvvvv",
+    broadcast ? "--broadcast" : "",
+    callerPrivateKey ? `--private-key ${callerPrivateKey}` : "",
+    debug ? "--debug" : "",
+  ]);
+
+  process.exit(0);
+};

package/src/commands/create.ts

@@ -0,0 +1,54 @@
+import { Arguments, CommandBuilder } from "yargs";
+import { exec } from "../utils";
+
+type Options = {
+  name: string;
+};
+
+export const command = "create <name>";
+export const desc = "Sets up a fresh mud project into <name>. Requires yarn.";
+
+export const builder: CommandBuilder<Options, Options> = (yargs) =>
+  yargs.positional("name", { type: "string", demandOption: true });
+
+export const handler = async (argv: Arguments<Options>): Promise<void> => {
+  const { name } = argv;
+  console.log("Creating new mud project in", name);
+
+  console.log("Cloning...");
+  await exec(`git clone https://github.com/latticexyz/mud _mudtemp`);
+
+  console.log("Moving...");
+  await exec(`cp -r _mudtemp/packages/ri ${name}`);
+
+  console.log("Setting up vscode solidity settings...");
+  await exec(`cp -r _mudtemp/.vscode ${name}/.vscode`);
+
+  console.log("Cleaning up...");
+  await exec(`rm -rf _mudtemp`);
+
+  console.log("Setting up package.json...");
+  await exec(`mv ${name}/packagejson.template ${name}/package.json`);
+
+  console.log("Installing dependencies using yarn...");
+  await exec(`cd ${name} && yarn install`);
+
+  console.log("Setting up foundry.toml...");
+  await exec(`rm ${name}/contracts/foundry.toml`);
+  await exec(`mv ${name}/contracts/foundrytoml.template ${name}/contracts/foundry.toml`);
+
+  console.log("Setting up remappings...");
+  await exec(`rm ${name}/contracts/remappings.txt`);
+  await exec(`mv ${name}/contracts/remappingstxt.template ${name}/contracts/remappings.txt`);
+
+  console.log("Setting up compile task...");
+  await exec(`rm ${name}/contracts/tasks/compile.ts`);
+  await exec(`mv ${name}/contracts/tasks/compilets.template ${name}/contracts/tasks/compile.ts`);
+
+  console.log("Building contracts...");
+  await exec(`cd ${name}/contracts && yarn build`);
+
+  console.log("Done setting up! Run `yarn start` to start client and chain, then head to localhost:3000 to explore.");
+
+  process.exit(0);
+};