feat(cli): generate system ABI's from World address

.changeset/breezy-peas-pay.md

@@ -0,0 +1,5 @@
+---
+"@latticexyz/cli": patch
+---
+
+Added a new `mud generate-abi` command that generates an ABI for a given World by reading the onchain system registrations.

packages/cli/src/commands/generate-abi.ts

@@ -0,0 +1,59 @@
+import type { CommandModule, InferredOptionTypes } from "yargs";
+import { Hex, createWalletClient, http } from "viem";
+import { getWorldDeploy } from "../deploy/getWorldDeploy";
+import { getRpcUrl } from "@latticexyz/common/foundry";
+import fs from "node:fs/promises";
+import path from "node:path";
+import { mkdirSync } from "node:fs";
+import { getWorldAbi } from "../utils/getWorldAbi";
+
+const ABI_DIRECTORY = "abis";
+const ABI_FILE = "worldRegisteredFunctions.abi.json";
+
+const generateAbiOptions = {
+  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 generateAbiOptions>;
+
+const commandModule: CommandModule<Options, Options> = {
+  command: "generate-abi",
+
+  describe: "Generate ABI's for Systems and World based on World address",
+
+  builder(yargs) {
+    return yargs.options(generateAbiOptions);
+  },
+
+  async handler(args) {
+    await generateAbiHandler(args);
+    process.exit(0);
+  },
+};
+
+export async function generateAbiHandler(opts: Options) {
+  const worldAddress = opts.worldAddress as Hex;
+  const profile = opts.profile ?? process.env.FOUNDRY_PROFILE;
+  const rpc = opts.rpc ?? (await getRpcUrl(profile));
+
+  const client = createWalletClient({
+    transport: http(rpc),
+  });
+
+  const worldDeploy = await getWorldDeploy(client, worldAddress);
+
+  mkdirSync(ABI_DIRECTORY);
+
+  // render World ABI
+  const worldAbi = await getWorldAbi({ client, worldDeploy });
+
+  const fullOutputPath = path.join(ABI_DIRECTORY, ABI_FILE);
+  await fs.writeFile(fullOutputPath, JSON.stringify(worldAbi));
+}
+
+export default commandModule;

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 generateAbi from "./generate-abi";
 
 // 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,
+  generateAbi,
 ];

packages/cli/src/index.ts

@@ -1 +1,4 @@
-// nothing to export
+import { getWorldAbi } from "./utils/getWorldAbi";
+import { getWorldDeploy } from "./deploy/getWorldDeploy";
+
+export { getWorldAbi, getWorldDeploy };

packages/cli/src/utils/functionSignatureToAbiItem.ts

@@ -0,0 +1,6 @@
+import { AbiItem, parseAbiItem } from "viem";
+
+export function functionSignatureToAbiItem(functionSignature: string): AbiItem {
+  const formattedSignature = `function ${functionSignature}`;
+  return parseAbiItem(formattedSignature);
+}

packages/cli/src/utils/getWorldAbi.ts

@@ -0,0 +1,21 @@
+import { Abi } from "abitype";
+import { getSystems } from "../deploy/getSystems";
+import { functionSignatureToAbiItem } from "./functionSignatureToAbiItem";
+import { Client } from "viem";
+import { WorldDeploy } from "../deploy/common";
+
+export async function getWorldAbi({
+  client,
+  worldDeploy,
+}: {
+  readonly client: Client;
+  readonly worldDeploy: WorldDeploy;
+}): Promise<Abi> {
+  const systems = await getSystems({ client, worldDeploy });
+
+  const worldAbi = systems.flatMap((system) =>
+    system.functions.map((func) => functionSignatureToAbiItem(func.signature)),
+  );
+
+  return worldAbi;
+}