create-mud 2.2.17-78e9ed1294db2e924bd295734f3738bdd2786242 → 2.2.17-86f455c0a09d5d8af64d030669ebf30ffa71420b

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

@@ -0,0 +1,321 @@
+// SPDX-License-Identifier: MIT
+pragma solidity >=0.8.24;
+
+/* Autogenerated file. Do not edit manually. */
+
+// Import store internals
+import { IStore } from "@latticexyz/store/src/IStore.sol";
+import { StoreSwitch } from "@latticexyz/store/src/StoreSwitch.sol";
+import { StoreCore } from "@latticexyz/store/src/StoreCore.sol";
+import { Bytes } from "@latticexyz/store/src/Bytes.sol";
+import { Memory } from "@latticexyz/store/src/Memory.sol";
+import { SliceLib } from "@latticexyz/store/src/Slice.sol";
+import { EncodeArray } from "@latticexyz/store/src/tightcoder/EncodeArray.sol";
+import { FieldLayout } from "@latticexyz/store/src/FieldLayout.sol";
+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";
+
+// Import user types
+import { Entity } from "../../Entity.sol";
+
+struct PositionData {
+  int32 x;
+  int32 y;
+}
+
+library Position {
+  // Hex below is the result of `WorldResourceIdLib.encode({ namespace: "app", name: "Position", typeId: RESOURCE_TABLE });`
+  ResourceId constant _tableId = ResourceId.wrap(0x74626170700000000000000000000000506f736974696f6e0000000000000000);
+
+  FieldLayout constant _fieldLayout =
+    FieldLayout.wrap(0x0008020004040000000000000000000000000000000000000000000000000000);
+
+  // Hex-encoded key schema of (bytes32)
+  Schema constant _keySchema = Schema.wrap(0x002001005f000000000000000000000000000000000000000000000000000000);
+  // Hex-encoded value schema of (int32, int32)
+  Schema constant _valueSchema = Schema.wrap(0x0008020023230000000000000000000000000000000000000000000000000000);
+
+  /**
+   * @notice Get the table's key field names.
+   * @return keyNames An array of strings with the names of key fields.
+   */
+  function getKeyNames() internal pure returns (string[] memory keyNames) {
+    keyNames = new string[](1);
+    keyNames[0] = "id";
+  }
+
+  /**
+   * @notice Get the table's value field names.
+   * @return fieldNames An array of strings with the names of value fields.
+   */
+  function getFieldNames() internal pure returns (string[] memory fieldNames) {
+    fieldNames = new string[](2);
+    fieldNames[0] = "x";
+    fieldNames[1] = "y";
+  }
+
+  /**
+   * @notice Register the table with its config.
+   */
+  function register() internal {
+    StoreSwitch.registerTable(_tableId, _fieldLayout, _keySchema, _valueSchema, getKeyNames(), getFieldNames());
+  }
+
+  /**
+   * @notice Register the table with its config.
+   */
+  function _register() internal {
+    StoreCore.registerTable(_tableId, _fieldLayout, _keySchema, _valueSchema, getKeyNames(), getFieldNames());
+  }
+
+  /**
+   * @notice Get x.
+   */
+  function getX(Entity id) internal view returns (int32 x) {
+    bytes32[] memory _keyTuple = new bytes32[](1);
+    _keyTuple[0] = Entity.unwrap(id);
+
+    bytes32 _blob = StoreSwitch.getStaticField(_tableId, _keyTuple, 0, _fieldLayout);
+    return (int32(uint32(bytes4(_blob))));
+  }
+
+  /**
+   * @notice Get x.
+   */
+  function _getX(Entity id) internal view returns (int32 x) {
+    bytes32[] memory _keyTuple = new bytes32[](1);
+    _keyTuple[0] = Entity.unwrap(id);
+
+    bytes32 _blob = StoreCore.getStaticField(_tableId, _keyTuple, 0, _fieldLayout);
+    return (int32(uint32(bytes4(_blob))));
+  }
+
+  /**
+   * @notice Set x.
+   */
+  function setX(Entity id, int32 x) internal {
+    bytes32[] memory _keyTuple = new bytes32[](1);
+    _keyTuple[0] = Entity.unwrap(id);
+
+    StoreSwitch.setStaticField(_tableId, _keyTuple, 0, abi.encodePacked((x)), _fieldLayout);
+  }
+
+  /**
+   * @notice Set x.
+   */
+  function _setX(Entity id, int32 x) internal {
+    bytes32[] memory _keyTuple = new bytes32[](1);
+    _keyTuple[0] = Entity.unwrap(id);
+
+    StoreCore.setStaticField(_tableId, _keyTuple, 0, abi.encodePacked((x)), _fieldLayout);
+  }
+
+  /**
+   * @notice Get y.
+   */
+  function getY(Entity id) internal view returns (int32 y) {
+    bytes32[] memory _keyTuple = new bytes32[](1);
+    _keyTuple[0] = Entity.unwrap(id);
+
+    bytes32 _blob = StoreSwitch.getStaticField(_tableId, _keyTuple, 1, _fieldLayout);
+    return (int32(uint32(bytes4(_blob))));
+  }
+
+  /**
+   * @notice Get y.
+   */
+  function _getY(Entity id) internal view returns (int32 y) {
+    bytes32[] memory _keyTuple = new bytes32[](1);
+    _keyTuple[0] = Entity.unwrap(id);
+
+    bytes32 _blob = StoreCore.getStaticField(_tableId, _keyTuple, 1, _fieldLayout);
+    return (int32(uint32(bytes4(_blob))));
+  }
+
+  /**
+   * @notice Set y.
+   */
+  function setY(Entity id, int32 y) internal {
+    bytes32[] memory _keyTuple = new bytes32[](1);
+    _keyTuple[0] = Entity.unwrap(id);
+
+    StoreSwitch.setStaticField(_tableId, _keyTuple, 1, abi.encodePacked((y)), _fieldLayout);
+  }
+
+  /**
+   * @notice Set y.
+   */
+  function _setY(Entity id, int32 y) internal {
+    bytes32[] memory _keyTuple = new bytes32[](1);
+    _keyTuple[0] = Entity.unwrap(id);
+
+    StoreCore.setStaticField(_tableId, _keyTuple, 1, abi.encodePacked((y)), _fieldLayout);
+  }
+
+  /**
+   * @notice Get the full data.
+   */
+  function get(Entity id) internal view returns (PositionData memory _table) {
+    bytes32[] memory _keyTuple = new bytes32[](1);
+    _keyTuple[0] = Entity.unwrap(id);
+
+    (bytes memory _staticData, EncodedLengths _encodedLengths, bytes memory _dynamicData) = StoreSwitch.getRecord(
+      _tableId,
+      _keyTuple,
+      _fieldLayout
+    );
+    return decode(_staticData, _encodedLengths, _dynamicData);
+  }
+
+  /**
+   * @notice Get the full data.
+   */
+  function _get(Entity id) internal view returns (PositionData memory _table) {
+    bytes32[] memory _keyTuple = new bytes32[](1);
+    _keyTuple[0] = Entity.unwrap(id);
+
+    (bytes memory _staticData, EncodedLengths _encodedLengths, bytes memory _dynamicData) = StoreCore.getRecord(
+      _tableId,
+      _keyTuple,
+      _fieldLayout
+    );
+    return decode(_staticData, _encodedLengths, _dynamicData);
+  }
+
+  /**
+   * @notice Set the full data using individual values.
+   */
+  function set(Entity id, int32 x, int32 y) internal {
+    bytes memory _staticData = encodeStatic(x, y);
+
+    EncodedLengths _encodedLengths;
+    bytes memory _dynamicData;
+
+    bytes32[] memory _keyTuple = new bytes32[](1);
+    _keyTuple[0] = Entity.unwrap(id);
+
+    StoreSwitch.setRecord(_tableId, _keyTuple, _staticData, _encodedLengths, _dynamicData);
+  }
+
+  /**
+   * @notice Set the full data using individual values.
+   */
+  function _set(Entity id, int32 x, int32 y) internal {
+    bytes memory _staticData = encodeStatic(x, y);
+
+    EncodedLengths _encodedLengths;
+    bytes memory _dynamicData;
+
+    bytes32[] memory _keyTuple = new bytes32[](1);
+    _keyTuple[0] = Entity.unwrap(id);
+
+    StoreCore.setRecord(_tableId, _keyTuple, _staticData, _encodedLengths, _dynamicData, _fieldLayout);
+  }
+
+  /**
+   * @notice Set the full data using the data struct.
+   */
+  function set(Entity id, PositionData memory _table) internal {
+    bytes memory _staticData = encodeStatic(_table.x, _table.y);
+
+    EncodedLengths _encodedLengths;
+    bytes memory _dynamicData;
+
+    bytes32[] memory _keyTuple = new bytes32[](1);
+    _keyTuple[0] = Entity.unwrap(id);
+
+    StoreSwitch.setRecord(_tableId, _keyTuple, _staticData, _encodedLengths, _dynamicData);
+  }
+
+  /**
+   * @notice Set the full data using the data struct.
+   */
+  function _set(Entity id, PositionData memory _table) internal {
+    bytes memory _staticData = encodeStatic(_table.x, _table.y);
+
+    EncodedLengths _encodedLengths;
+    bytes memory _dynamicData;
+
+    bytes32[] memory _keyTuple = new bytes32[](1);
+    _keyTuple[0] = Entity.unwrap(id);
+
+    StoreCore.setRecord(_tableId, _keyTuple, _staticData, _encodedLengths, _dynamicData, _fieldLayout);
+  }
+
+  /**
+   * @notice Decode the tightly packed blob of static data using this table's field layout.
+   */
+  function decodeStatic(bytes memory _blob) internal pure returns (int32 x, int32 y) {
+    x = (int32(uint32(Bytes.getBytes4(_blob, 0))));
+
+    y = (int32(uint32(Bytes.getBytes4(_blob, 4))));
+  }
+
+  /**
+   * @notice Decode the tightly packed blobs using this table's field layout.
+   * @param _staticData Tightly packed static fields.
+   *
+   *
+   */
+  function decode(
+    bytes memory _staticData,
+    EncodedLengths,
+    bytes memory
+  ) internal pure returns (PositionData memory _table) {
+    (_table.x, _table.y) = decodeStatic(_staticData);
+  }
+
+  /**
+   * @notice Delete all data for given keys.
+   */
+  function deleteRecord(Entity id) internal {
+    bytes32[] memory _keyTuple = new bytes32[](1);
+    _keyTuple[0] = Entity.unwrap(id);
+
+    StoreSwitch.deleteRecord(_tableId, _keyTuple);
+  }
+
+  /**
+   * @notice Delete all data for given keys.
+   */
+  function _deleteRecord(Entity id) internal {
+    bytes32[] memory _keyTuple = new bytes32[](1);
+    _keyTuple[0] = Entity.unwrap(id);
+
+    StoreCore.deleteRecord(_tableId, _keyTuple, _fieldLayout);
+  }
+
+  /**
+   * @notice Tightly pack static (fixed length) data using this table's schema.
+   * @return The static data, encoded into a sequence of bytes.
+   */
+  function encodeStatic(int32 x, int32 y) internal pure returns (bytes memory) {
+    return abi.encodePacked(x, y);
+  }
+
+  /**
+   * @notice Encode all of a record's fields.
+   * @return The static (fixed length) data, encoded into a sequence of bytes.
+   * @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(int32 x, int32 y) internal pure returns (bytes memory, EncodedLengths, bytes memory) {
+    bytes memory _staticData = encodeStatic(x, y);
+
+    EncodedLengths _encodedLengths;
+    bytes memory _dynamicData;
+
+    return (_staticData, _encodedLengths, _dynamicData);
+  }
+
+  /**
+   * @notice Encode keys as a bytes32 array using this table's field layout.
+   */
+  function encodeKeyTuple(Entity id) internal pure returns (bytes32[] memory) {
+    bytes32[] memory _keyTuple = new bytes32[](1);
+    _keyTuple[0] = Entity.unwrap(id);
+
+    return _keyTuple;
+  }
+}

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

@@ -3,17 +3,14 @@ pragma solidity >=0.8.24;
 
 /* Autogenerated file. Do not edit manually. */
 
+import { Entity } from "../../Entity.sol";
+import { Direction } from "../common.sol";
+
 /**
- * @title ITasksSystem
+ * @title IMoveSystem
  * @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 ITasksSystem {
-  function app__addTask(string memory description) external returns (bytes32 id);
-
-  function app__completeTask(bytes32 id) external;
-
-  function app__resetTask(bytes32 id) external;
-
-  function app__deleteTask(bytes32 id) external;
+interface IMoveSystem {
+  function app__move(Entity entity, Direction direction) external;
 }

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

@@ -0,0 +1,15 @@
+// SPDX-License-Identifier: MIT
+pragma solidity >=0.8.24;
+
+/* Autogenerated file. Do not edit manually. */
+
+import { Entity } from "../../Entity.sol";
+
+/**
+ * @title ISpawnSystem
+ * @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 ISpawnSystem {
+  function app__spawn() external returns (Entity entity);
+}

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

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

package/templates/react-ecs/packages/contracts/src/createEntity.sol

@@ -0,0 +1,11 @@
+// SPDX-License-Identifier: MIT
+pragma solidity >=0.8.24;
+
+import { Entity } from "./Entity.sol";
+import { EntityCount } from "./codegen/tables/EntityCount.sol";
+
+function createEntity() returns (Entity entity) {
+  uint256 next = EntityCount.get() + 1;
+  EntityCount.set(next);
+  return Entity.wrap(bytes32(next));
+}

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

@@ -0,0 +1,39 @@
+// SPDX-License-Identifier: MIT
+pragma solidity >=0.8.24;
+
+import "forge-std/Test.sol";
+import { MudTest } from "@latticexyz/world/test/MudTest.t.sol";
+
+import { IWorld } from "../src/codegen/world/IWorld.sol";
+import { Owner } from "../src/codegen/tables/Owner.sol";
+import { Position, PositionData } from "../src/codegen/tables/Position.sol";
+import { Direction } from "../src/codegen/common.sol";
+import { Entity } from "../src/Entity.sol";
+
+contract MoveTest is MudTest {
+  uint256 deployerPrivateKey = vm.envUint("PRIVATE_KEY");
+  address deployer = vm.addr(deployerPrivateKey);
+
+  address alice = vm.addr(uint256(keccak256("alice")));
+  address bob = vm.addr(uint256(keccak256("bob")));
+
+  function testMove() public {
+    Entity entity = Entity.wrap(keccak256("entity"));
+    vm.prank(deployer);
+    Owner.set(entity, alice);
+
+    PositionData memory position = Position.get(entity);
+    assertEq(position.x, 0);
+    assertEq(position.y, 0);
+
+    vm.prank(alice);
+    IWorld(worldAddress).app__move(entity, Direction.North);
+    position = Position.get(entity);
+    assertEq(position.x, 0);
+    assertEq(position.y, 1);
+
+    vm.prank(bob);
+    vm.expectRevert("You cannot move this entity.");
+    IWorld(worldAddress).app__move(entity, Direction.North);
+  }
+}

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

@@ -0,0 +1,16 @@
+// SPDX-License-Identifier: MIT
+pragma solidity >=0.8.24;
+
+import "forge-std/Test.sol";
+import { MudTest } from "@latticexyz/world/test/MudTest.t.sol";
+
+contract WorldTest is MudTest {
+  function testWorldDeployed() public {
+    uint256 codeSize;
+    address addr = worldAddress;
+    assembly {
+      codeSize := extcodesize(addr)
+    }
+    assertTrue(codeSize > 0);
+  }
+}

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

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

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

@@ -1,21 +0,0 @@
-import { createContext, ReactNode, useContext } from "react";
-import { SetupResult } from "./mud/setup";
-
-const MUDContext = createContext<SetupResult | null>(null);
-
-type Props = {
-  children: ReactNode;
-  value: SetupResult;
-};
-
-export const MUDProvider = ({ children, value }: Props) => {
-  const currentValue = useContext(MUDContext);
-  if (currentValue) throw new Error("MUDProvider can only be used once");
-  return <MUDContext.Provider value={value}>{children}</MUDContext.Provider>;
-};
-
-export const useMUD = () => {
-  const value = useContext(MUDContext);
-  if (!value) throw new Error("Must be used within a MUDProvider");
-  return value;
-};

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

@@ -1,56 +0,0 @@
-/*
- * Create the system calls that the client can use to ask
- * for changes in the World state (using the System contracts).
- */
-
-import { Hex } from "viem";
-import { SetupNetworkResult } from "./setupNetwork";
-
-export type SystemCalls = ReturnType<typeof createSystemCalls>;
-
-export function createSystemCalls(
-  /*
-   * The parameter list informs TypeScript that:
-   *
-   * - The first parameter is expected to be a
-   *   SetupNetworkResult, as defined in setupNetwork.ts
-   *
-   *   Out of this parameter, we only care about two fields:
-   *   - worldContract (which comes from getContract, see
-   *     https://github.com/latticexyz/mud/blob/main/templates/react/packages/client/src/mud/setupNetwork.ts#L63-L69).
-   *
-   *   - waitForTransaction (which comes from syncToRecs, see
-   *     https://github.com/latticexyz/mud/blob/main/templates/react/packages/client/src/mud/setupNetwork.ts#L77-L83).
-   *
-   * - From the second parameter, which is a ClientComponent,
-   *   we only care about Counter. This parameter comes to use
-   *   through createClientComponents.ts, but it originates in
-   *   syncToRecs
-   *   (https://github.com/latticexyz/mud/blob/main/templates/react/packages/client/src/mud/setupNetwork.ts#L77-L83).
-   */
-  { tables, useStore, worldContract, waitForTransaction }: SetupNetworkResult,
-) {
-  const addTask = async (label: string) => {
-    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.app__resetTask([id])
-      : await worldContract.write.app__completeTask([id]);
-    await waitForTransaction(tx);
-  };
-
-  const deleteTask = async (id: Hex) => {
-    const tx = await worldContract.write.app__deleteTask([id]);
-    await waitForTransaction(tx);
-  };
-
-  return {
-    addTask,
-    toggleTask,
-    deleteTask,
-  };
-}

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

@@ -1,76 +0,0 @@
-/*
- * Network specific configuration for the client.
- * By default connect to the anvil test network.
- *
- */
-
-/*
- * By default the template just creates a temporary wallet
- * (called a burner wallet).
- */
-import { getBurnerPrivateKey } from "@latticexyz/common";
-
-/*
- * Import the addresses of the World, possibly on multiple chains,
- * from packages/contracts/worlds.json. When the contracts package
- * deploys a new `World`, it updates this file.
- */
-import worlds from "contracts/worlds.json";
-
-/*
- * The supported chains.
- */
-import { supportedChains } from "./supportedChains";
-
-export async function getNetworkConfig() {
-  const params = new URLSearchParams(window.location.search);
-
-  /*
-   * The chain ID is the first item available from this list:
-   * 1. chainId query parameter
-   * 2. chainid query parameter
-   * 3. The VITE_CHAIN_ID environment variable set when the
-   *    vite dev server was started or client was built
-   * 4. The default, 31337 (anvil)
-   */
-  const chainId = Number(params.get("chainId") || params.get("chainid") || import.meta.env.VITE_CHAIN_ID || 31337);
-
-  /*
-   * Find the chain (unless it isn't in the list of supported chains).
-   */
-  const chainIndex = supportedChains.findIndex((c) => c.id === chainId);
-  const chain = supportedChains[chainIndex];
-  if (!chain) {
-    throw new Error(`Chain ${chainId} not found`);
-  }
-
-  /*
-   * Get the address of the World. If you want to use a
-   * different address than the one in worlds.json,
-   * provide it as worldAddress in the query string.
-   */
-  const world = worlds[chain.id.toString()];
-  const worldAddress = params.get("worldAddress") || world?.address;
-  if (!worldAddress) {
-    throw new Error(`No world address found for chain ${chainId}. Did you run \`mud deploy\`?`);
-  }
-
-  /*
-   * MUD clients use events to synchronize the database, meaning
-   * they need to look as far back as when the World was started.
-   * The block number for the World start can be specified either
-   * on the URL (as initialBlockNumber) or in the worlds.json
-   * file. If neither has it, it starts at the first block, zero.
-   */
-  const initialBlockNumber = params.has("initialBlockNumber")
-    ? Number(params.get("initialBlockNumber"))
-    : world?.blockNumber ?? 0n;
-
-  return {
-    privateKey: getBurnerPrivateKey(),
-    chainId,
-    chain,
-    worldAddress,
-    initialBlockNumber,
-  };
-}

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

@@ -1,18 +0,0 @@
-/*
- * This file sets up all the definitions required for a MUD client.
- */
-
-import { createSystemCalls } from "./createSystemCalls";
-import { setupNetwork } from "./setupNetwork";
-
-export type SetupResult = Awaited<ReturnType<typeof setup>>;
-
-export async function setup() {
-  const network = await setupNetwork();
-  const systemCalls = createSystemCalls(network);
-
-  return {
-    network,
-    systemCalls,
-  };
-}