create-mud 2.2.17-ce0e08e6fdf17a061e41a062a2684a592ec15f2f → 2.2.17-d5f4e1e44bbc260ff21dacdfab0e0f8389e9f304

package/templates/react-ecs/packages/client/src/mud/setupNetwork.ts

@@ -0,0 +1,106 @@
+/*
+ * The MUD client code is built on top of viem
+ * (https://viem.sh/docs/getting-started.html).
+ * This line imports the functions we need from it.
+ */
+import {
+  createPublicClient,
+  fallback,
+  webSocket,
+  http,
+  createWalletClient,
+  Hex,
+  ClientConfig,
+  getContract,
+} from "viem";
+import { encodeEntity, syncToRecs } from "@latticexyz/store-sync/recs";
+
+import { getNetworkConfig } from "./getNetworkConfig";
+import { world } from "./world";
+import IWorldAbi from "contracts/out/IWorld.sol/IWorld.abi.json";
+import { createBurnerAccount, transportObserver, ContractWrite } from "@latticexyz/common";
+import { transactionQueue, writeObserver } from "@latticexyz/common/actions";
+
+import { Subject, share } from "rxjs";
+
+/*
+ * Import our MUD config, which includes strong types for
+ * our tables and other config options. We use this to generate
+ * things like RECS components and get back strong types for them.
+ *
+ * See https://mud.dev/templates/typescript/contracts#mudconfigts
+ * for the source of this information.
+ */
+import mudConfig from "contracts/mud.config";
+
+export type SetupNetworkResult = Awaited<ReturnType<typeof setupNetwork>>;
+
+export async function setupNetwork() {
+  const networkConfig = await getNetworkConfig();
+
+  /*
+   * Create a viem public (read only) client
+   * (https://viem.sh/docs/clients/public.html)
+   */
+  const clientOptions = {
+    chain: networkConfig.chain,
+    transport: transportObserver(fallback([webSocket(), http()])),
+    pollingInterval: 1000,
+  } as const satisfies ClientConfig;
+
+  const publicClient = createPublicClient(clientOptions);
+
+  /*
+   * Create an observable for contract writes that we can
+   * pass into MUD dev tools for transaction observability.
+   */
+  const write$ = new Subject<ContractWrite>();
+
+  /*
+   * Create a temporary wallet and a viem client for it
+   * (see https://viem.sh/docs/clients/wallet.html).
+   */
+  const burnerAccount = createBurnerAccount(networkConfig.privateKey as Hex);
+  const burnerWalletClient = createWalletClient({
+    ...clientOptions,
+    account: burnerAccount,
+  })
+    .extend(transactionQueue())
+    .extend(writeObserver({ onWrite: (write) => write$.next(write) }));
+
+  /*
+   * Create an object for communicating with the deployed World.
+   */
+  const worldContract = getContract({
+    address: networkConfig.worldAddress as Hex,
+    abi: IWorldAbi,
+    client: { public: publicClient, wallet: burnerWalletClient },
+  });
+
+  /*
+   * Sync on-chain state into RECS and keeps our client in sync.
+   * Uses the MUD indexer if available, otherwise falls back
+   * to the viem publicClient to make RPC calls to fetch MUD
+   * events from the chain.
+   */
+  const { components, latestBlock$, storedBlockLogs$, waitForTransaction } = await syncToRecs({
+    world,
+    config: mudConfig,
+    address: networkConfig.worldAddress as Hex,
+    publicClient,
+    startBlock: BigInt(networkConfig.initialBlockNumber),
+  });
+
+  return {
+    world,
+    components,
+    playerEntity: encodeEntity({ address: "address" }, { address: burnerWalletClient.account.address }),
+    publicClient,
+    walletClient: burnerWalletClient,
+    latestBlock$,
+    storedBlockLogs$,
+    waitForTransaction,
+    worldContract,
+    write$: write$.asObservable().pipe(share()),
+  };
+}

package/templates/react-ecs/packages/client/src/mud/supportedChains.ts

@@ -0,0 +1,20 @@
+/*
+ * The supported chains.
+ * By default, there are only two chains here:
+ *
+ * - mudFoundry, the chain running on anvil that pnpm dev
+ *   starts by default. It is similar to the viem anvil chain
+ *   (see https://viem.sh/docs/clients/test.html), but with the
+ *   basefee set to zero to avoid transaction fees.
+ * - Redstone, our production blockchain (https://redstone.xyz/)
+ * - Garnet, our test blockchain (https://garnetchain.com/))
+ *
+ */
+
+import { MUDChain, mudFoundry, redstone, garnet } from "@latticexyz/common/chains";
+
+/*
+ * See https://mud.dev/guides/hello-world/add-chain-client
+ * for instructions on how to add networks.
+ */
+export const supportedChains: MUDChain[] = [mudFoundry, redstone, garnet];

package/templates/react-ecs/packages/client/src/mud/world.ts

@@ -0,0 +1,3 @@
+import { createWorld } from "@latticexyz/recs";
+
+export const world = createWorld();

package/templates/react-ecs/packages/client/tsconfig.json

@@ -1,7 +1,7 @@
 {
   "extends": "../../tsconfig.json",
   "compilerOptions": {
-    "types": ["vite/client", "vite-plugin-mud/env"],
+    "types": ["vite/client"],
     "target": "ESNext",
     "lib": ["ESNext", "DOM"],
     "jsx": "react-jsx",

package/templates/react-ecs/packages/client/vite.config.ts

@@ -1,9 +1,14 @@
 import { defineConfig } from "vite";
 import react from "@vitejs/plugin-react";
-import { mud } from "vite-plugin-mud";
 
 export default defineConfig({
-  plugins: [react(), mud({ worldsFile: "../contracts/worlds.json" })],
+  plugins: [react()],
+  server: {
+    port: 3000,
+    fs: {
+      strict: false,
+    },
+  },
   build: {
     target: "es2022",
     minify: true,

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

@@ -7,5 +7,5 @@
 # Enable debug logs for MUD CLI
 DEBUG=mud:*
 #
-# Anvil default private key
+# Anvil default private key:
 PRIVATE_KEY=0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80

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-ecs/packages/contracts/src/codegen/world/{ISpawnSystem.sol → IIncrementSystem.sol}

@@ -3,13 +3,11 @@ pragma solidity >=0.8.24;
 
 /* Autogenerated file. Do not edit manually. */
 
-import { Entity } from "../../Entity.sol";
-
 /**
- * @title ISpawnSystem
+ * @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 ISpawnSystem {
-  function app__spawn() external returns (Entity entity);
+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/contracts/.gitignore_

@@ -1,13 +0,0 @@
-# foundry
-cache
-broadcast
-out/*
-!out/IWorld.sol
-out/IWorld.sol/*
-!out/IWorld.sol/IWorld.abi.json
-!out/IWorld.sol/IWorld.abi.d.json.ts
-
-# mud
-.mud
-deploys
-*.db*

package/templates/react-ecs/.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-ecs/packages/client/.gitignore_

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

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

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

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

@@ -1,29 +0,0 @@
-import { WagmiProvider } from "wagmi";
-import { QueryClientProvider, QueryClient } from "@tanstack/react-query";
-import { ReactNode } from "react";
-import { SyncProvider } from "@latticexyz/store-sync/react";
-import { defineConfig, EntryKitProvider } from "@latticexyz/entrykit/internal";
-import { wagmiConfig } from "./wagmiConfig";
-import { chainId, getWorldAddress, startBlock } from "./common";
-import { syncAdapter } from "./mud/recs";
-
-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={syncAdapter}>
-            {children}
-          </SyncProvider>
-        </EntryKitProvider>
-      </QueryClientProvider>
-    </WagmiProvider>
-  );
-}

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

@@ -1,27 +0,0 @@
-import mudConfig from "contracts/mud.config";
-import { chains } from "./wagmiConfig";
-import { Chain, Hex } 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 Entity = Hex;
-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;
-}