feat(world): strip world prefix from function names when encoding system calls (#3527)

Author: frolic

.changeset/large-days-confess.md

@@ -0,0 +1,12 @@
+---
+"@latticexyz/world": patch
+---
+
+Using `encodeSystemCall` (and others) with a world ABI and namespace-prefixed function name will now attempt to strip the prefix when encoding it as a system call.
+
+It's recommended to use a system ABI with these functions rather than a world ABI.
+
+```ts
+import systemAbi from "contracts/out/ISomeSystem.sol/ISomeSystem.sol.abi.json";
+encodeSystemCall({ abi: systemAbi, ... });
+```

packages/world/ts/encodeSystemCall.ts

@@ -1,13 +1,22 @@
 import { Abi, EncodeFunctionDataParameters, Hex, encodeFunctionData, type ContractFunctionName } from "viem";
 import type { AbiParametersToPrimitiveTypes, ExtractAbiFunction } from "abitype";
 import { worldCallAbi } from "./worldCallAbi";
+import { internal_normalizeSystemFunctionName } from "./normalizeSystemFunctionName";
 
-export type SystemCall<abi extends Abi, functionName extends ContractFunctionName<abi>> = EncodeFunctionDataParameters<
-  abi,
-  functionName
-> & {
+export type SystemCall<abi extends Abi, functionName extends ContractFunctionName<abi>> = {
+  /**
+   * System ABI
+   */
+  readonly abi: abi;
+  /**
+   * System's resource ID
+   */
   readonly systemId: Hex;
-};
+  /**
+   * System function name to call
+   */
+  readonly functionName: functionName;
+} & Pick<EncodeFunctionDataParameters<abi, functionName>, "args">;
 
 /** Encode a system call to be passed as arguments into `World.call` */
 export function encodeSystemCall<abi extends Abi, functionName extends ContractFunctionName<abi>>({
@@ -20,7 +29,7 @@ export function encodeSystemCall<abi extends Abi, functionName extends ContractF
     systemId,
     encodeFunctionData<abi, functionName>({
       abi,
-      functionName,
+      functionName: internal_normalizeSystemFunctionName(systemId, functionName),
       args,
     } as EncodeFunctionDataParameters<abi, functionName>),
   ];

packages/world/ts/encodeSystemCallFrom.ts

@@ -2,6 +2,7 @@ import { Abi, EncodeFunctionDataParameters, encodeFunctionData, Address, type Co
 import type { AbiParametersToPrimitiveTypes, ExtractAbiFunction } from "abitype";
 import { SystemCall } from "./encodeSystemCall";
 import { worldCallAbi } from "./worldCallAbi";
+import { internal_normalizeSystemFunctionName } from "./normalizeSystemFunctionName";
 
 export type SystemCallFrom<abi extends Abi, functionName extends ContractFunctionName<abi>> = SystemCall<
   abi,
@@ -25,7 +26,7 @@ export function encodeSystemCallFrom<abi extends Abi, functionName extends Contr
     systemId,
     encodeFunctionData<abi, functionName>({
       abi,
-      functionName,
+      functionName: internal_normalizeSystemFunctionName(systemId, functionName),
       args,
     } as EncodeFunctionDataParameters<abi, functionName>),
   ];

packages/world/ts/encodeSystemCalls.ts

@@ -2,6 +2,7 @@ import { Abi, EncodeFunctionDataParameters, encodeFunctionData, type ContractFun
 import { SystemCall } from "./encodeSystemCall";
 import type { AbiParametersToPrimitiveTypes, ExtractAbiFunction } from "abitype";
 import { worldCallAbi } from "./worldCallAbi";
+import { internal_normalizeSystemFunctionName } from "./normalizeSystemFunctionName";
 
 /** Encode system calls to be passed as arguments into `World.batchCall` */
 export function encodeSystemCalls<abi extends Abi, functionName extends ContractFunctionName<abi>>(
@@ -13,7 +14,7 @@ export function encodeSystemCalls<abi extends Abi, functionName extends Contract
       systemId,
       callData: encodeFunctionData<abi, functionName>({
         abi,
-        functionName,
+        functionName: internal_normalizeSystemFunctionName(systemId, functionName),
         args,
       } as EncodeFunctionDataParameters<abi, functionName>),
     })),

packages/world/ts/encodeSystemCallsFrom.ts

@@ -2,6 +2,7 @@ import { Abi, Address, EncodeFunctionDataParameters, encodeFunctionData, type Co
 import { SystemCallFrom } from "./encodeSystemCallFrom";
 import type { AbiParametersToPrimitiveTypes, ExtractAbiFunction } from "abitype";
 import { worldCallAbi } from "./worldCallAbi";
+import { internal_normalizeSystemFunctionName } from "./normalizeSystemFunctionName";
 
 /** Encode system calls to be passed as arguments into `World.batchCallFrom` */
 export function encodeSystemCallsFrom<abi extends Abi, functionName extends ContractFunctionName<abi>>(
@@ -15,7 +16,7 @@ export function encodeSystemCallsFrom<abi extends Abi, functionName extends Cont
       systemId,
       callData: encodeFunctionData<abi, functionName>({
         abi,
-        functionName,
+        functionName: internal_normalizeSystemFunctionName(systemId, functionName),
         args,
       } as EncodeFunctionDataParameters<abi, functionName>),
     })),

packages/world/ts/normalizeSystemFunctionName.ts

@@ -0,0 +1,16 @@
+import { hexToResource, resourceToLabel } from "@latticexyz/common";
+import { Hex } from "viem";
+
+/** @internal */
+export function internal_normalizeSystemFunctionName(systemId: Hex, functionName: string) {
+  const resource = hexToResource(systemId);
+  const worldFunctionPrefix = resource.namespace !== "" ? `${resource.namespace}__` : null;
+  if (worldFunctionPrefix != null && functionName.startsWith(worldFunctionPrefix)) {
+    console.warn(
+      // eslint-disable-next-line max-len
+      `Detected world function name "${functionName}" used in call to system "${resourceToLabel(resource)}".\n\nIt's recommended to use a system ABI and system function name with these methods instead.`,
+    );
+    return functionName.slice(worldFunctionPrefix.length);
+  }
+  return functionName;
+}