feat(create-mud): use app namespace (#2823)

Co-authored-by: Kevin Ingersoll <[email protected]>

.changeset/fuzzy-tools-explain.md

@@ -0,0 +1,5 @@
+---
+"@latticexyz/create-mud": patch
+---
+
+Templates now use an `app` namespace by default, instead of the root namespace. This helps keep the root namespace clear for intentionally root-level things and avoids pitfalls with root systems calling other root systems.

templates/phaser/packages/client/src/mud/createSystemCalls.ts

@@ -46,7 +46,7 @@ export function createSystemCalls(
      * is in the root namespace, `.increment` can be called directly
      * on the World contract.
      */
-    const tx = await worldContract.write.increment();
+    const tx = await worldContract.write.app__increment();
     await waitForTransaction(tx);
     return getComponentValue(Counter, singletonEntity);
   };

templates/phaser/packages/contracts/mud.config.ts

@@ -1,6 +1,7 @@
 import { defineWorld } from "@latticexyz/world";
 
 export default defineWorld({
+  namespace: "app",
   tables: {
     Counter: {
       schema: {

templates/phaser/packages/contracts/script/PostDeploy.s.sol

@@ -21,7 +21,7 @@ contract PostDeploy is Script {
     // ------------------ EXAMPLES ------------------
 
     // Call increment on the world via the registered function selector
-    uint32 newValue = IWorld(worldAddress).increment();
+    uint32 newValue = IWorld(worldAddress).app__increment();
     console.log("Increment via IWorld:", newValue);
 
     vm.stopBroadcast();

templates/phaser/packages/contracts/test/CounterTest.t.sol

@@ -24,7 +24,7 @@ contract CounterTest is MudTest {
     assertEq(counter, 1);
 
     // Expect the counter to be 2 after calling increment.
-    IWorld(worldAddress).increment();
+    IWorld(worldAddress).app__increment();
     counter = Counter.get();
     assertEq(counter, 2);
   }

templates/react-ecs/packages/client/src/mud/createSystemCalls.ts

@@ -40,7 +40,7 @@ export function createSystemCalls(
      * is in the root namespace, `.increment` can be called directly
      * on the World contract.
      */
-    const tx = await worldContract.write.increment();
+    const tx = await worldContract.write.app__increment();
     await waitForTransaction(tx);
     return getComponentValue(Counter, singletonEntity);
   };

templates/react-ecs/packages/contracts/mud.config.ts

@@ -1,6 +1,7 @@
 import { defineWorld } from "@latticexyz/world";
 
 export default defineWorld({
+  namespace: "app",
   tables: {
     Counter: {
       schema: {

templates/react-ecs/packages/contracts/script/PostDeploy.s.sol

@@ -21,7 +21,7 @@ contract PostDeploy is Script {
     // ------------------ EXAMPLES ------------------
 
     // Call increment on the world via the registered function selector
-    uint32 newValue = IWorld(worldAddress).increment();
+    uint32 newValue = IWorld(worldAddress).app__increment();
     console.log("Increment via IWorld:", newValue);
 
     vm.stopBroadcast();

templates/react-ecs/packages/contracts/test/CounterTest.t.sol

@@ -24,7 +24,7 @@ contract CounterTest is MudTest {
     assertEq(counter, 1);
 
     // Expect the counter to be 2 after calling increment.
-    IWorld(worldAddress).increment();
+    IWorld(worldAddress).app__increment();
     counter = Counter.get();
     assertEq(counter, 2);
   }

templates/react/packages/client/src/mud/createSystemCalls.ts

@@ -31,18 +31,20 @@ export function createSystemCalls(
   { tables, useStore, worldContract, waitForTransaction }: SetupNetworkResult,
 ) {
   const addTask = async (label: string) => {
-    const tx = await worldContract.write.addTask([label]);
+    const tx = await worldContract.write.app__addTask([label]);
     await waitForTransaction(tx);
   };
 
   const toggleTask = async (id: Hex) => {
     const isComplete = (useStore.getState().getValue(tables.Tasks, { id })?.completedAt ?? 0n) > 0n;
-    const tx = isComplete ? await worldContract.write.resetTask([id]) : await worldContract.write.completeTask([id]);
+    const tx = isComplete
+      ? await worldContract.write.app__resetTask([id])
+      : await worldContract.write.app__completeTask([id]);
     await waitForTransaction(tx);
   };
 
   const deleteTask = async (id: Hex) => {
-    const tx = await worldContract.write.deleteTask([id]);
+    const tx = await worldContract.write.app__deleteTask([id]);
     await waitForTransaction(tx);
   };
 

templates/react/packages/contracts/mud.config.ts

@@ -1,6 +1,7 @@
 import { defineWorld } from "@latticexyz/world";
 
 export default defineWorld({
+  namespace: "app",
   tables: {
     Tasks: {
       schema: {

templates/react/packages/contracts/script/PostDeploy.s.sol

@@ -23,10 +23,10 @@ contract PostDeploy is Script {
     Tasks.set("1", TasksData({ description: "Walk the dog", createdAt: block.timestamp, completedAt: 0 }));
 
     // Or we can call our own systems
-    IWorld(worldAddress).addTask("Take out the trash");
+    IWorld(worldAddress).app__addTask("Take out the trash");
 
-    bytes32 key = IWorld(worldAddress).addTask("Do the dishes");
-    IWorld(worldAddress).completeTask(key);
+    bytes32 key = IWorld(worldAddress).app__addTask("Do the dishes");
+    IWorld(worldAddress).app__completeTask(key);
 
     vm.stopBroadcast();
   }

templates/react/packages/contracts/test/TasksTest.t.sol

@@ -24,7 +24,7 @@ contract TasksTest is MudTest {
     assertEq(task.completedAt, 0);
 
     // Expect the task to be completed after calling completeTask from our TasksSystem
-    IWorld(worldAddress).completeTask("1");
+    IWorld(worldAddress).app__completeTask("1");
     assertEq(Tasks.getCompletedAt("1"), block.timestamp);
   }
 }

templates/threejs/packages/client/src/mud/createSystemCalls.ts

@@ -37,7 +37,7 @@ export function createSystemCalls(
      * Because MoveSystem is in the root namespace, .move can be called directly
      * on the World contract.
      */
-    const tx = await worldContract.write.move([x, y, z]);
+    const tx = await worldContract.write.app__move([x, y, z]);
     await waitForTransaction(tx);
   };
 

templates/threejs/packages/contracts/mud.config.ts

@@ -1,6 +1,7 @@
 import { defineWorld } from "@latticexyz/world";
 
 export default defineWorld({
+  namespace: "app",
   tables: {
     Position: {
       schema: {

templates/vanilla/packages/client/src/mud/createSystemCalls.ts

@@ -40,7 +40,7 @@ export function createSystemCalls(
      * is in the root namespace, `.increment` can be called directly
      * on the World contract.
      */
-    const tx = await worldContract.write.increment();
+    const tx = await worldContract.write.app__increment();
     await waitForTransaction(tx);
     return getComponentValue(Counter, singletonEntity);
   };

templates/vanilla/packages/contracts/mud.config.ts

@@ -1,6 +1,7 @@
 import { defineWorld } from "@latticexyz/world";
 
 export default defineWorld({
+  namespace: "app",
   tables: {
     Counter: {
       schema: {

templates/vanilla/packages/contracts/script/PostDeploy.s.sol

@@ -21,7 +21,7 @@ contract PostDeploy is Script {
     // ------------------ EXAMPLES ------------------
 
     // Call increment on the world via the registered function selector
-    uint32 newValue = IWorld(worldAddress).increment();
+    uint32 newValue = IWorld(worldAddress).app__increment();
     console.log("Increment via IWorld:", newValue);
 
     vm.stopBroadcast();

templates/vanilla/packages/contracts/test/CounterTest.t.sol

@@ -24,7 +24,7 @@ contract CounterTest is MudTest {
     assertEq(counter, 1);
 
     // Expect the counter to be 2 after calling increment.
-    IWorld(worldAddress).increment();
+    IWorld(worldAddress).app__increment();
     counter = Counter.get();
     assertEq(counter, 2);
   }