create-mud 2.2.17-6e19b86633174dbbf98eb1a2b4446ef6f0b22ab7 → 2.2.17-78e9ed1294db2e924bd295734f3738bdd2786242

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

@@ -2,17 +2,12 @@ import { defineWorld } from "@latticexyz/world";
 
 export default defineWorld({
   namespace: "app",
-  userTypes: {
-    Entity: { type: "bytes32", filePath: "./src/Entity.sol" },
-  },
-  enums: {
-    Direction: ["North", "East", "South", "West"],
-  },
   tables: {
-    // singletons
-    EntityCount: { schema: { count: "uint256" }, key: [] },
-    // components
-    Owner: { id: "Entity", owner: "address" },
-    Position: { id: "Entity", x: "int32", y: "int32" },
+    Counter: {
+      schema: {
+        value: "uint32",
+      },
+      key: [],
+    },
   },
 });

package/templates/react-ecs/packages/contracts/package.json

@@ -17,7 +17,6 @@
   },
   "dependencies": {
     "@latticexyz/cli": "{{mud-version}}",
-    "@latticexyz/entrykit": "{{mud-version}}",
     "@latticexyz/schema-type": "{{mud-version}}",
     "@latticexyz/store": "{{mud-version}}",
     "@latticexyz/world": "{{mud-version}}",

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

@@ -18,7 +18,11 @@ contract PostDeploy is Script {
     // Start broadcasting transactions from the deployer account
     vm.startBroadcast(deployerPrivateKey);
 
-    // TODO
+    // ------------------ EXAMPLES ------------------
+
+    // Call increment on the world via the registered function selector
+    uint32 newValue = IWorld(worldAddress).app__increment();
+    console.log("Increment via IWorld:", newValue);
 
     vm.stopBroadcast();
   }

package/templates/react-ecs/packages/contracts/src/codegen/index.sol

@@ -3,6 +3,4 @@ pragma solidity >=0.8.24;
 
 /* Autogenerated file. Do not edit manually. */
 
-import { EntityCount } from "./tables/EntityCount.sol";
-import { Owner } from "./tables/Owner.sol";
-import { Position, PositionData } from "./tables/Position.sol";
+import { Counter } from "./tables/Counter.sol";

package/templates/react-ecs/packages/contracts/src/codegen/tables/{EntityCount.sol → Counter.sol}

@@ -16,17 +16,17 @@ import { Schema } from "@latticexyz/store/src/Schema.sol";
 import { EncodedLengths, EncodedLengthsLib } from "@latticexyz/store/src/EncodedLengths.sol";
 import { ResourceId } from "@latticexyz/store/src/ResourceId.sol";
 
-library EntityCount {
-  // Hex below is the result of `WorldResourceIdLib.encode({ namespace: "app", name: "EntityCount", typeId: RESOURCE_TABLE });`
-  ResourceId constant _tableId = ResourceId.wrap(0x74626170700000000000000000000000456e74697479436f756e740000000000);
+library Counter {
+  // Hex below is the result of `WorldResourceIdLib.encode({ namespace: "app", name: "Counter", typeId: RESOURCE_TABLE });`
+  ResourceId constant _tableId = ResourceId.wrap(0x74626170700000000000000000000000436f756e746572000000000000000000);
 
   FieldLayout constant _fieldLayout =
-    FieldLayout.wrap(0x0020010020000000000000000000000000000000000000000000000000000000);
+    FieldLayout.wrap(0x0004010004000000000000000000000000000000000000000000000000000000);
 
   // Hex-encoded key schema of ()
   Schema constant _keySchema = Schema.wrap(0x0000000000000000000000000000000000000000000000000000000000000000);
-  // Hex-encoded value schema of (uint256)
-  Schema constant _valueSchema = Schema.wrap(0x002001001f000000000000000000000000000000000000000000000000000000);
+  // Hex-encoded value schema of (uint32)
+  Schema constant _valueSchema = Schema.wrap(0x0004010003000000000000000000000000000000000000000000000000000000);
 
   /**
    * @notice Get the table's key field names.
@@ -42,7 +42,7 @@ library EntityCount {
    */
   function getFieldNames() internal pure returns (string[] memory fieldNames) {
     fieldNames = new string[](1);
-    fieldNames[0] = "count";
+    fieldNames[0] = "value";
   }
 
   /**
@@ -60,79 +60,79 @@ library EntityCount {
   }
 
   /**
-   * @notice Get count.
+   * @notice Get value.
    */
-  function getCount() internal view returns (uint256 count) {
+  function getValue() internal view returns (uint32 value) {
     bytes32[] memory _keyTuple = new bytes32[](0);
 
     bytes32 _blob = StoreSwitch.getStaticField(_tableId, _keyTuple, 0, _fieldLayout);
-    return (uint256(bytes32(_blob)));
+    return (uint32(bytes4(_blob)));
   }
 
   /**
-   * @notice Get count.
+   * @notice Get value.
    */
-  function _getCount() internal view returns (uint256 count) {
+  function _getValue() internal view returns (uint32 value) {
     bytes32[] memory _keyTuple = new bytes32[](0);
 
     bytes32 _blob = StoreCore.getStaticField(_tableId, _keyTuple, 0, _fieldLayout);
-    return (uint256(bytes32(_blob)));
+    return (uint32(bytes4(_blob)));
   }
 
   /**
-   * @notice Get count.
+   * @notice Get value.
    */
-  function get() internal view returns (uint256 count) {
+  function get() internal view returns (uint32 value) {
     bytes32[] memory _keyTuple = new bytes32[](0);
 
     bytes32 _blob = StoreSwitch.getStaticField(_tableId, _keyTuple, 0, _fieldLayout);
-    return (uint256(bytes32(_blob)));
+    return (uint32(bytes4(_blob)));
   }
 
   /**
-   * @notice Get count.
+   * @notice Get value.
    */
-  function _get() internal view returns (uint256 count) {
+  function _get() internal view returns (uint32 value) {
     bytes32[] memory _keyTuple = new bytes32[](0);
 
     bytes32 _blob = StoreCore.getStaticField(_tableId, _keyTuple, 0, _fieldLayout);
-    return (uint256(bytes32(_blob)));
+    return (uint32(bytes4(_blob)));
   }
 
   /**
-   * @notice Set count.
+   * @notice Set value.
    */
-  function setCount(uint256 count) internal {
+  function setValue(uint32 value) internal {
     bytes32[] memory _keyTuple = new bytes32[](0);
 
-    StoreSwitch.setStaticField(_tableId, _keyTuple, 0, abi.encodePacked((count)), _fieldLayout);
+    StoreSwitch.setStaticField(_tableId, _keyTuple, 0, abi.encodePacked((value)), _fieldLayout);
   }
 
   /**
-   * @notice Set count.
+   * @notice Set value.
    */
-  function _setCount(uint256 count) internal {
+  function _setValue(uint32 value) internal {
     bytes32[] memory _keyTuple = new bytes32[](0);
 
-    StoreCore.setStaticField(_tableId, _keyTuple, 0, abi.encodePacked((count)), _fieldLayout);
+    StoreCore.setStaticField(_tableId, _keyTuple, 0, abi.encodePacked((value)), _fieldLayout);
   }
 
   /**
-   * @notice Set count.
+   * @notice Set value.
    */
-  function set(uint256 count) internal {
+  function set(uint32 value) internal {
     bytes32[] memory _keyTuple = new bytes32[](0);
 
-    StoreSwitch.setStaticField(_tableId, _keyTuple, 0, abi.encodePacked((count)), _fieldLayout);
+    StoreSwitch.setStaticField(_tableId, _keyTuple, 0, abi.encodePacked((value)), _fieldLayout);
   }
 
   /**
-   * @notice Set count.
+   * @notice Set value.
    */
-  function _set(uint256 count) internal {
+  function _set(uint32 value) internal {
     bytes32[] memory _keyTuple = new bytes32[](0);
 
-    StoreCore.setStaticField(_tableId, _keyTuple, 0, abi.encodePacked((count)), _fieldLayout);
+    StoreCore.setStaticField(_tableId, _keyTuple, 0, abi.encodePacked((value)), _fieldLayout);
   }
 
   /**
@@ -157,8 +157,8 @@ library EntityCount {
    * @notice Tightly pack static (fixed length) data using this table's schema.
    * @return The static data, encoded into a sequence of bytes.
    */
-  function encodeStatic(uint256 count) internal pure returns (bytes memory) {
-    return abi.encodePacked(count);
+  function encodeStatic(uint32 value) internal pure returns (bytes memory) {
+    return abi.encodePacked(value);
   }
 
   /**
@@ -167,8 +167,8 @@ library EntityCount {
    * @return The lengths of the dynamic fields (packed into a single bytes32 value).
    * @return The dynamic (variable length) data, encoded into a sequence of bytes.
    */
-  function encode(uint256 count) internal pure returns (bytes memory, EncodedLengths, bytes memory) {
-    bytes memory _staticData = encodeStatic(count);
+  function encode(uint32 value) internal pure returns (bytes memory, EncodedLengths, bytes memory) {
+    bytes memory _staticData = encodeStatic(value);
 
     EncodedLengths _encodedLengths;
     bytes memory _dynamicData;

package/templates/{react/packages/contracts/src/codegen/world/IMoveSystem.sol → react-ecs/packages/contracts/src/codegen/world/IIncrementSystem.sol}

@@ -3,13 +3,11 @@ pragma solidity >=0.8.24;
 
 /* Autogenerated file. Do not edit manually. */
 
-import { Direction } from "../common.sol";
-
 /**
- * @title IMoveSystem
+ * @title IIncrementSystem
  * @author MUD (https://mud.dev) by Lattice (https://lattice.xyz)
  * @dev This interface is automatically generated from the corresponding system contract. Do not edit manually.
  */
-interface IMoveSystem {
-  function app__move(Direction direction) external;
+interface IIncrementSystem {
+  function app__increment() external returns (uint32);
 }

package/templates/react-ecs/packages/contracts/src/codegen/world/IWorld.sol

@@ -4,8 +4,7 @@ pragma solidity >=0.8.24;
 /* Autogenerated file. Do not edit manually. */
 
 import { IBaseWorld } from "@latticexyz/world/src/codegen/interfaces/IBaseWorld.sol";
-import { IMoveSystem } from "./IMoveSystem.sol";
-import { ISpawnSystem } from "./ISpawnSystem.sol";
+import { IIncrementSystem } from "./IIncrementSystem.sol";
 
 /**
  * @title IWorld
@@ -14,4 +13,4 @@ import { ISpawnSystem } from "./ISpawnSystem.sol";
  * that are dynamically registered in the World during deployment.
  * @dev This is an autogenerated file; do not edit manually.
  */
-interface IWorld is IBaseWorld, IMoveSystem, ISpawnSystem {}
+interface IWorld is IBaseWorld, IIncrementSystem {}

package/templates/react-ecs/packages/contracts/src/systems/IncrementSystem.sol

@@ -0,0 +1,14 @@
+// SPDX-License-Identifier: MIT
+pragma solidity >=0.8.24;
+
+import { System } from "@latticexyz/world/src/System.sol";
+import { Counter } from "../codegen/index.sol";
+
+contract IncrementSystem is System {
+  function increment() public returns (uint32) {
+    uint32 counter = Counter.get();
+    uint32 newValue = counter + 1;
+    Counter.set(newValue);
+    return newValue;
+  }
+}

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

@@ -0,0 +1,31 @@
+// SPDX-License-Identifier: MIT
+pragma solidity >=0.8.24;
+
+import "forge-std/Test.sol";
+import { MudTest } from "@latticexyz/world/test/MudTest.t.sol";
+import { getKeysWithValue } from "@latticexyz/world-modules/src/modules/keyswithvalue/getKeysWithValue.sol";
+
+import { IWorld } from "../src/codegen/world/IWorld.sol";
+import { Counter } from "../src/codegen/index.sol";
+
+contract CounterTest is MudTest {
+  function testWorldExists() public {
+    uint256 codeSize;
+    address addr = worldAddress;
+    assembly {
+      codeSize := extcodesize(addr)
+    }
+    assertTrue(codeSize > 0);
+  }
+
+  function testCounter() public {
+    // Expect the counter to be 1 because it was incremented in the PostDeploy script.
+    uint32 counter = Counter.get();
+    assertEq(counter, 1);
+
+    // Expect the counter to be 2 after calling increment.
+    IWorld(worldAddress).app__increment();
+    counter = Counter.get();
+    assertEq(counter, 2);
+  }
+}

package/templates/react-ecs/packages/contracts/worlds.json

@@ -1,5 +1,5 @@
 {
   "31337": {
-    "address": "0xfdf868ea710ffd8cd33b829c5aff79edd15ecd5f"
+    "address": "0x8d8b6b8414e1e3dcfd4168561b9be6bd3bf6ec4b"
   }
 }

package/templates/phaser/.gitignore_

@@ -1,7 +0,0 @@
-node_modules
-
-# mud artifacts
-.mud
-# sqlite indexer data
-*.db
-*.db-journal

package/templates/phaser/packages/client/.gitignore_

@@ -1,3 +0,0 @@
-node_modules
-dist
-.DS_Store

package/templates/phaser/packages/contracts/.gitignore_

@@ -1,9 +0,0 @@
-out/
-cache/
-node_modules/
-bindings/
-artifacts/
-broadcast/
-
-# Ignore MUD deploy artifacts
-deploys/**/*.json

package/templates/react/.gitignore_

@@ -1,16 +0,0 @@
-.DS_Store
-logs
-*.log
-
-node_modules
-
-.env.*
-
-# foundry
-cache
-broadcast
-out/*
-!out/IWorld.sol
-out/IWorld.sol/*
-!out/IWorld.sol/IWorld.abi.json
-!out/IWorld.sol/IWorld.abi.d.json.ts

package/templates/react/packages/client/.gitignore_

@@ -1 +0,0 @@
-dist

package/templates/react/packages/client/postcss.config.cjs

@@ -1,6 +0,0 @@
-module.exports = {
-  plugins: {
-    tailwindcss: {},
-    autoprefixer: {},
-  },
-};

package/templates/react/packages/client/src/Providers.tsx

@@ -1,35 +0,0 @@
-import { WagmiProvider } from "wagmi";
-import { QueryClientProvider, QueryClient } from "@tanstack/react-query";
-import { ReactNode } from "react";
-import { createSyncAdapter } from "@latticexyz/store-sync/internal";
-import { SyncProvider } from "@latticexyz/store-sync/react";
-import { stash } from "./mud/stash";
-import { defineConfig, EntryKitProvider } from "@latticexyz/entrykit/internal";
-import { wagmiConfig } from "./wagmiConfig";
-import { chainId, getWorldAddress, startBlock } from "./common";
-
-const queryClient = new QueryClient();
-
-export type Props = {
-  children: ReactNode;
-};
-
-export function Providers({ children }: Props) {
-  const worldAddress = getWorldAddress();
-  return (
-    <WagmiProvider config={wagmiConfig}>
-      <QueryClientProvider client={queryClient}>
-        <EntryKitProvider config={defineConfig({ chainId, worldAddress })}>
-          <SyncProvider
-            chainId={chainId}
-            address={worldAddress}
-            startBlock={startBlock}
-            adapter={createSyncAdapter({ stash })}
-          >
-            {children}
-          </SyncProvider>
-        </EntryKitProvider>
-      </QueryClientProvider>
-    </WagmiProvider>
-  );
-}

package/templates/react/packages/client/src/common.ts

@@ -1,26 +0,0 @@
-import mudConfig from "contracts/mud.config";
-import { chains } from "./wagmiConfig";
-import { Chain } from "viem";
-
-export const chainId = import.meta.env.CHAIN_ID;
-export const worldAddress = import.meta.env.WORLD_ADDRESS;
-export const startBlock = import.meta.env.START_BLOCK;
-
-export const url = new URL(window.location.href);
-
-export type Direction = (typeof mudConfig.enums.Direction)[number];
-
-export function getWorldAddress() {
-  if (!worldAddress) {
-    throw new Error("No world address configured. Is the world still deploying?");
-  }
-  return worldAddress;
-}
-
-export function getChain(): Chain {
-  const chain = chains.find((c) => c.id === chainId);
-  if (!chain) {
-    throw new Error(`No chain configured for chain ID ${chainId}.`);
-  }
-  return chain;
-}

package/templates/react/packages/client/src/game/GameMap.tsx

@@ -1,102 +0,0 @@
-import { serialize, useAccount } from "wagmi";
-import { useKeyboardMovement } from "./useKeyboardMovement";
-import { Address, Hex, hexToBigInt, keccak256 } from "viem";
-import { ArrowDownIcon } from "../ui/icons/ArrowDownIcon";
-import { twMerge } from "tailwind-merge";
-import { Direction } from "../common";
-import mudConfig from "contracts/mud.config";
-import { AsyncButton } from "../ui/AsyncButton";
-import { useAccountModal } from "@latticexyz/entrykit/internal";
-
-export type Props = {
-  readonly players?: readonly {
-    readonly player: Address;
-    readonly x: number;
-    readonly y: number;
-  }[];
-
-  readonly onMove?: (direction: Direction) => Promise<void>;
-};
-
-const size = 40;
-const scale = 100 / size;
-
-function getColorAngle(seed: Hex) {
-  return Number(hexToBigInt(keccak256(seed)) % 360n);
-}
-
-const rotateClassName = {
-  North: "rotate-0",
-  East: "rotate-90",
-  South: "rotate-180",
-  West: "-rotate-90",
-} as const satisfies Record<Direction, `${"" | "-"}rotate-${number}`>;
-
-export function GameMap({ players = [], onMove }: Props) {
-  const { openAccountModal } = useAccountModal();
-  const { address: userAddress } = useAccount();
-  const currentPlayer = players.find((player) => player.player.toLowerCase() === userAddress?.toLowerCase());
-  useKeyboardMovement(onMove);
-  return (
-    <div className="aspect-square w-full max-w-[40rem]">
-      <div className="relative w-full h-full border-8 border-black/10">
-        {onMove
-          ? mudConfig.enums.Direction.map((direction) => (
-              <button
-                key={direction}
-                title={`Move ${direction.toLowerCase()}`}
-                className={twMerge(
-                  "outline-0 absolute inset-0 cursor-pointer grid p-4",
-                  rotateClassName[direction],
-                  "transition bg-gradient-to-t from-transparent via-transparent to-blue-50 text-blue-400 opacity-0 hover:opacity-40 active:opacity-100",
-                )}
-                style={{ clipPath: "polygon(0% 0%, 100% 0%, 50% 50%)" }}
-                onClick={() => onMove(direction)}
-              >
-                <ArrowDownIcon className="rotate-180 text-4xl self-start justify-self-center" />
-              </button>
-            ))
-          : null}
-
-        {players.map((player) => (
-          <div
-            key={player.player}
-            className="absolute bg-current"
-            style={{
-              color: `hwb(${getColorAngle(player.player)} 40% 20%)`,
-              width: `${scale}%`,
-              height: `${scale}%`,
-              left: `${((((player.x + size / 2) % size) + size) % size) * scale}%`,
-              top: `${((size - ((player.y + size / 2) % size)) % size) * scale}%`,
-            }}
-            title={serialize(player, null, 2)}
-          >
-            {player === currentPlayer ? <div className="w-full h-full bg-current animate-ping opacity-50" /> : null}
-          </div>
-        ))}
-
-        {!currentPlayer ? (
-          onMove ? (
-            <div className="absolute inset-0 grid place-items-center">
-              <AsyncButton
-                className="group outline-0 p-4 border-4 border-green-400 transition ring-green-300 hover:ring-4 active:scale-95 rounded-lg text-lg font-medium aria-busy:pointer-events-none aria-busy:animate-pulse"
-                onClick={() => onMove("North")}
-              >
-                Spawn<span className="hidden group-aria-busy:inline">ing…</span>
-              </AsyncButton>
-            </div>
-          ) : (
-            <div className="absolute inset-0 grid place-items-center">
-              <button
-                className="group outline-0 p-4 border-4 border-green-400 transition ring-green-300 hover:ring-4 active:scale-95 rounded-lg text-lg font-medium aria-busy:pointer-events-none aria-busy:animate-pulse"
-                onClick={openAccountModal}
-              >
-                Sign in to play
-              </button>
-            </div>
-          )
-        ) : null}
-      </div>
-    </div>
-  );
-}

package/templates/react/packages/client/src/game/useKeyboardMovement.ts

@@ -1,26 +0,0 @@
-import { useEffect } from "react";
-import { Direction } from "../common";
-
-const keys = new Map<KeyboardEvent["key"], Direction>([
-  ["ArrowUp", "North"],
-  ["ArrowRight", "East"],
-  ["ArrowDown", "South"],
-  ["ArrowLeft", "West"],
-]);
-
-export const useKeyboardMovement = (move: undefined | ((direction: Direction) => void)) => {
-  useEffect(() => {
-    if (!move) return;
-
-    const listener = (event: KeyboardEvent) => {
-      const direction = keys.get(event.key);
-      if (direction == null) return;
-
-      event.preventDefault();
-      move(direction);
-    };
-
-    window.addEventListener("keydown", listener);
-    return () => window.removeEventListener("keydown", listener);
-  }, [move]);
-};

package/templates/react/packages/client/src/mud/Explorer.tsx

@@ -1,32 +0,0 @@
-import { useState } from "react";
-import { getChain, getWorldAddress } from "../common";
-import { MUDIcon } from "../ui/icons/MUDIcon";
-
-export function Explorer() {
-  const [open, setOpen] = useState(false);
-
-  const chain = getChain();
-  const worldAddress = getWorldAddress();
-
-  const explorerUrl = chain.blockExplorers?.worldsExplorer?.url;
-  if (!explorerUrl) return null;
-
-  return (
-    <div className="fixed bottom-0 inset-x-0 flex flex-col opacity-80 transition hover:opacity-100">
-      <button
-        type="button"
-        onClick={() => setOpen(!open)}
-        className="outline-none flex justify-end gap-2 p-2 font-medium leading-none text-black"
-      >
-        {open ? (
-          <>Close</>
-        ) : (
-          <>
-            Explore <MUDIcon className="text-orange-500" />
-          </>
-        )}
-      </button>
-      {open ? <iframe src={`${explorerUrl}/${worldAddress}`} className="bg-black h-[50vh]" /> : null}
-    </div>
-  );
-}

package/templates/react/packages/client/src/mud/Synced.tsx

@@ -1,14 +0,0 @@
-import { ReactNode } from "react";
-import { useSyncStatus } from "./useSyncStatus";
-import { TableRecord } from "@latticexyz/stash/internal";
-import { SyncProgress } from "@latticexyz/store-sync/internal";
-
-export type Props = {
-  children: ReactNode;
-  fallback?: (props: TableRecord<typeof SyncProgress>) => ReactNode;
-};
-
-export function Synced({ children, fallback }: Props) {
-  const status = useSyncStatus();
-  return status.isLive ? children : fallback?.(status);
-}

package/templates/react/packages/client/src/mud/stash.ts

@@ -1,4 +0,0 @@
-import { createStash } from "@latticexyz/stash/internal";
-import config from "contracts/mud.config";
-
-export const stash = createStash(config);

package/templates/react/packages/client/src/mud/useSyncStatus.ts

@@ -1,21 +0,0 @@
-import { stash } from "./stash";
-import { initialProgress, SyncProgress } from "@latticexyz/store-sync/internal";
-import { SyncStep } from "@latticexyz/store-sync";
-import { useMemo } from "react";
-import { useRecord } from "@latticexyz/stash/react";
-
-export function useSyncStatus() {
-  const progress = useRecord({
-    stash,
-    table: SyncProgress,
-    key: {},
-    defaultValue: initialProgress,
-  });
-  return useMemo(
-    () => ({
-      ...progress,
-      isLive: progress.step === SyncStep.LIVE,
-    }),
-    [progress],
-  );
-}