feat(world): remove system name from function signatures/selectors [M-05]

.changeset/bright-kangaroos-battle.md

@@ -0,0 +1,8 @@
+---
+"@latticexyz/world-modules": patch
+"@latticexyz/world": major
+---
+
+Functions within namespaced systems are now registered on the world as `{namespace}_{functionName}` rather than `{namespace}_{systemName}_{functionName}`. This is more ergonomic and is more consistent with namespaced resources in other parts of the codebase (e.g. accessing tables in schemaful indexer).
+
+If you have a project using the `namespace` key in your `mud.config.ts` or are manually registering systems and function selectors on a namespace, you will likely need to codegen your system interfaces (`pnpm build`) and update any calls to these systems through the world's namespaced function signatures.

examples/minimal/packages/contracts/src/interfaces/IChatNamespacedSystem.sol

@@ -1,7 +1,6 @@
 // SPDX-License-Identifier: MIT
 pragma solidity >=0.8.21;
 
-// TODO allow overriding namespace per-system
 interface IChatNamespacedSystem {
-  function namespace_ChatNamespaced_sendMessage(string memory message) external;
+  function namespace_sendMessage(string memory message) external;
 }

examples/minimal/packages/contracts/test/ChatNamespaced.t.sol

@@ -22,6 +22,6 @@ contract ChatNamespacedTest is MudTest {
       MessageTable.encodeLengths(value),
       MessageTable.encodeDynamic(value)
     );
-    IChatNamespacedSystem(worldAddress).namespace_ChatNamespaced_sendMessage(value);
+    IChatNamespacedSystem(worldAddress).namespace_sendMessage(value);
   }
 }

packages/world-modules/gas-report.json

@@ -303,7 +303,7 @@
     "file": "test/UniqueEntityModule.t.sol",
     "test": "testInstall",
     "name": "install unique entity module",
-    "gasUsed": 704240
+    "gasUsed": 702338
   },
   {
     "file": "test/UniqueEntityModule.t.sol",
@@ -315,7 +315,7 @@
     "file": "test/UniqueEntityModule.t.sol",
     "test": "testInstallRoot",
     "name": "installRoot unique entity module",
-    "gasUsed": 673144
+    "gasUsed": 671242
   },
   {
     "file": "test/UniqueEntityModule.t.sol",

packages/world-modules/src/interfaces/IUniqueEntitySystem.sol

@@ -3,5 +3,5 @@ pragma solidity >=0.8.21;
 
 // TODO allow overriding namespace per-system (or a separate config for modules?)
 interface IUniqueEntitySystem {
-  function uniqueEntity_system_getUniqueEntity() external returns (bytes32 uniqueEntity);
+  function uniqueEntity_getUniqueEntity() external returns (bytes32 uniqueEntity);
 }

packages/world-modules/src/modules/uniqueentity/getUniqueEntity.sol

@@ -23,5 +23,5 @@ function getUniqueEntity() returns (bytes32 uniqueEntity) {
  * Increment and get an entity nonce.
  */
 function getUniqueEntity(IBaseWorld world) returns (bytes32 uniqueEntity) {
-  return IUniqueEntitySystem(address(world)).uniqueEntity_system_getUniqueEntity();
+  return IUniqueEntitySystem(address(world)).uniqueEntity_getUniqueEntity();
 }

packages/world/gas-report.json

@@ -105,7 +105,7 @@
     "file": "test/World.t.sol",
     "test": "testRegisterFunctionSelector",
     "name": "Register a function selector",
-    "gasUsed": 84519
+    "gasUsed": 81969
   },
   {
     "file": "test/World.t.sol",

packages/world/src/modules/core/implementations/WorldRegistrationSystem.sol

@@ -195,14 +195,7 @@ contract WorldRegistrationSystem is System, IWorldErrors, LimitedCallContext {
 
     // Compute global function selector
     string memory namespaceString = WorldResourceIdLib.toTrimmedString(systemId.getNamespace());
-    string memory nameString = WorldResourceIdLib.toTrimmedString(systemId.getName());
-    bytes memory worldFunctionSignature = abi.encodePacked(
-      namespaceString,
-      "_",
-      nameString,
-      "_",
-      systemFunctionSignature
-    );
+    bytes memory worldFunctionSignature = abi.encodePacked(namespaceString, "_", systemFunctionSignature);
     worldFunctionSelector = bytes4(keccak256(worldFunctionSignature));
 
     // Require the function selector to be globally unique

packages/world/test/World.t.sol

@@ -57,7 +57,7 @@ import { DelegationControlMock } from "./DelegationControlMock.sol";
 import { createCoreModule } from "./createCoreModule.sol";
 
 interface IWorldTestSystem {
-  function testNamespace_testSystem_err(string memory input) external pure;
+  function testNamespace_err(string memory input) external pure;
 }
 
 struct WorldTestSystemReturn {
@@ -1487,7 +1487,7 @@ contract WorldTest is Test, GasReporter {
     bytes4 functionSelector = world.registerFunctionSelector(systemId, "msgSender()");
     endGasReport();
 
-    string memory expectedWorldFunctionSignature = "testNamespace_testSystem_msgSender()";
+    string memory expectedWorldFunctionSignature = "testNamespace_msgSender()";
     bytes4 expectedWorldFunctionSelector = bytes4(keccak256(abi.encodePacked(expectedWorldFunctionSignature)));
     assertEq(functionSelector, expectedWorldFunctionSelector, "wrong function selector returned");
 
@@ -1502,7 +1502,7 @@ contract WorldTest is Test, GasReporter {
 
     // Expect errors to be passed through
     vm.expectRevert(abi.encodeWithSelector(WorldTestSystem.WorldTestSystemError.selector, "test error"));
-    IWorldTestSystem(address(world)).testNamespace_testSystem_err("test error");
+    IWorldTestSystem(address(world)).testNamespace_err("test error");
   }
 
   function testRegisterRootFunctionSelector() public {

packages/world/test/WorldBalance.t.sol

@@ -126,7 +126,7 @@ contract WorldBalanceTest is Test, GasReporter {
     // Call a function on a non-root system with value
     vm.deal(caller, value);
     vm.prank(caller);
-    (success, data) = address(world).call{ value: value }(abi.encodeWithSignature("namespace_testSystem_echoValue()"));
+    (success, data) = address(world).call{ value: value }(abi.encodeWithSignature("namespace_echoValue()"));
     assertTrue(success);
     assertEq(abi.decode(data, (uint256)), value);
 

packages/world/ts/node/render-solidity/worldgen.ts

@@ -42,11 +42,9 @@ export async function worldgen(
       }
     });
     const systemInterfaceName = `I${system.basename}`;
-    // create an interface using the external functions and imports
-    const { name } = resolvedConfig.systems[system.basename];
     const output = renderSystemInterface({
       name: systemInterfaceName,
-      functionPrefix: config.namespace === "" ? "" : `${config.namespace}_${name}_`,
+      functionPrefix: config.namespace === "" ? "" : `${config.namespace}_`,
       functions,
       errors,
       imports,