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

package/templates/react-ecs/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-ecs/packages/client/src/mud/createClientComponents.ts

@@ -1,21 +0,0 @@
-/*
- * Creates components for use by the client.
- *
- * By default it returns the components from setupNetwork.ts, those which are
- * automatically inferred from the mud.config.ts table definitions.
- *
- * However, you can add or override components here as needed. This
- * lets you add user defined components, which may or may not have
- * an onchain component.
- */
-
-import { SetupNetworkResult } from "./setupNetwork";
-
-export type ClientComponents = ReturnType<typeof createClientComponents>;
-
-export function createClientComponents({ components }: SetupNetworkResult) {
-  return {
-    ...components,
-    // add your client components or overrides here
-  };
-}

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

@@ -1,51 +0,0 @@
-/*
- * Create the system calls that the client can use to ask
- * for changes in the World state (using the System contracts).
- */
-
-import { getComponentValue } from "@latticexyz/recs";
-import { ClientComponents } from "./createClientComponents";
-import { SetupNetworkResult } from "./setupNetwork";
-import { singletonEntity } from "@latticexyz/store-sync/recs";
-
-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).
-   */
-  { worldContract, waitForTransaction }: SetupNetworkResult,
-  { Counter }: ClientComponents,
-) {
-  const increment = async () => {
-    /*
-     * Because IncrementSystem
-     * (https://mud.dev/templates/typescript/contracts#incrementsystemsol)
-     * is in the root namespace, `.increment` can be called directly
-     * on the World contract.
-     */
-    const tx = await worldContract.write.app__increment();
-    await waitForTransaction(tx);
-    return getComponentValue(Counter, singletonEntity);
-  };
-
-  return {
-    increment,
-  };
-}

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

@@ -1,77 +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.
- * By default, there are only two chains here:
- */
-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-ecs/packages/client/src/mud/setup.ts

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

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

@@ -1,106 +0,0 @@
-/*
- * 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

@@ -1,20 +0,0 @@
-/*
- * 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

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

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

@@ -1,14 +0,0 @@
-// 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

@@ -1,31 +0,0 @@
-// 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);
-  }
-}