feat(world): add TS helpers to encode system calls (#1745)

packages/world/package.json

@@ -51,6 +51,7 @@
     "@latticexyz/schema-type": "workspace:*",
     "@latticexyz/store": "workspace:*",
     "abitype": "0.9.8",
+    "viem": "1.14.0",
     "zod": "^3.21.4"
   },
   "devDependencies": {

packages/world/ts/encodeSystemCall.ts

@@ -0,0 +1,33 @@
+import {
+  Abi,
+  EncodeFunctionDataParameters,
+  ContractFunctionConfig,
+  GetFunctionArgs,
+  Hex,
+  encodeFunctionData,
+} from "viem";
+import IWorldCallAbi from "../out/IWorldKernel.sol/IWorldCall.abi.json";
+
+export type SystemCall<abi extends Abi, functionName extends string = string> = Pick<
+  ContractFunctionConfig<abi, functionName>,
+  "abi" | "functionName" | "args"
+> & {
+  readonly systemId: Hex;
+};
+
+/** Encode a system call to be passed as arguments into `World.call` */
+export function encodeSystemCall<abi extends Abi, functionName extends string = string>({
+  abi,
+  systemId,
+  functionName,
+  args,
+}: SystemCall<abi, functionName>): GetFunctionArgs<typeof IWorldCallAbi, "call">["args"] {
+  return [
+    systemId,
+    encodeFunctionData({
+      abi,
+      functionName,
+      args,
+    } as unknown as EncodeFunctionDataParameters<abi, functionName>),
+  ];
+}

packages/world/ts/encodeSystemCallFrom.ts

@@ -0,0 +1,26 @@
+import { Abi, EncodeFunctionDataParameters, GetFunctionArgs, encodeFunctionData, Address } from "viem";
+import IWorldCallAbi from "../out/IWorldKernel.sol/IWorldCall.abi.json";
+import { SystemCall } from "./encodeSystemCall";
+
+export type SystemCallFrom<abi extends Abi, functionName extends string = string> = SystemCall<abi, functionName> & {
+  readonly from: Address;
+};
+
+/** Encode a system call to be passed as arguments into `World.callFrom` */
+export function encodeSystemCallFrom<abi extends Abi, functionName extends string = string>({
+  abi,
+  from,
+  systemId,
+  functionName,
+  args,
+}: SystemCallFrom<abi, functionName>): GetFunctionArgs<typeof IWorldCallAbi, "callFrom">["args"] {
+  return [
+    from,
+    systemId,
+    encodeFunctionData({
+      abi,
+      functionName,
+      args,
+    } as unknown as EncodeFunctionDataParameters<abi, functionName>),
+  ];
+}

packages/world/ts/encodeSystemCalls.ts

@@ -0,0 +1,11 @@
+import { Abi, GetFunctionArgs } from "viem";
+import IWorldCallAbi from "../out/IWorldKernel.sol/IWorldCall.abi.json";
+import { SystemCall, encodeSystemCall } from "./encodeSystemCall";
+
+/** Encode system calls to be passed as arguments into `World.batchCall` */
+export function encodeSystemCalls<abi extends Abi, functionName extends string = string>(
+  abi: abi,
+  systemCalls: readonly Omit<SystemCall<abi, functionName>, "abi">[]
+): GetFunctionArgs<typeof IWorldCallAbi, "call">["args"][] {
+  return systemCalls.map((systemCall) => encodeSystemCall({ ...systemCall, abi } as SystemCall<abi, functionName>));
+}

packages/world/ts/encodeSystemCallsFrom.ts

@@ -0,0 +1,14 @@
+import { Abi, Address, GetFunctionArgs } from "viem";
+import IWorldCallAbi from "../out/IWorldKernel.sol/IWorldCall.abi.json";
+import { SystemCallFrom, encodeSystemCallFrom } from "./encodeSystemCallFrom";
+
+/** Encode system calls to be passed as arguments into `World.batchCallFrom` */
+export function encodeSystemCallsFrom<abi extends Abi, functionName extends string = string>(
+  abi: abi,
+  from: Address,
+  systemCalls: readonly Omit<SystemCallFrom<abi, functionName>, "abi" | "from">[]
+): GetFunctionArgs<typeof IWorldCallAbi, "callFrom">["args"][] {
+  return systemCalls.map((systemCall) =>
+    encodeSystemCallFrom({ ...systemCall, abi, from } as SystemCallFrom<abi, functionName>)
+  );
+}

packages/world/ts/index.ts

@@ -2,4 +2,9 @@ export * from "./config/defaults";
 export * from "./config/resolveWorldConfig";
 export * from "./config/types";
 export * from "./config/worldConfig";
+
+export * from "./encodeSystemCall";
+export * from "./encodeSystemCallFrom";
+export * from "./encodeSystemCalls";
+export * from "./encodeSystemCallsFrom";
 export * from "./worldEvents";