create-mud 2.2.17-f88e48e47ceb4a29a3862a3f3b85891490952f0e → 2.2.17

package/dist/templates/threejs/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/dist/templates/threejs/packages/client/src/index.tsx

@@ -1,34 +0,0 @@
-import ReactDOM from "react-dom/client";
-import { App } from "./App";
-import { setup } from "./mud/setup";
-import { MUDProvider } from "./MUDContext";
-import mudConfig from "contracts/mud.config";
-
-const rootElement = document.getElementById("react-root");
-if (!rootElement) throw new Error("React root not found");
-const root = ReactDOM.createRoot(rootElement);
-
-// TODO: figure out if we actually want this to be async or if we should render something else in the meantime
-setup().then(async (result) => {
-  root.render(
-    <MUDProvider value={result}>
-      <App />
-    </MUDProvider>,
-  );
-
-  // https://vitejs.dev/guide/env-and-mode.html
-  if (import.meta.env.DEV) {
-    const { mount: mountDevTools } = await import("@latticexyz/dev-tools");
-    mountDevTools({
-      config: mudConfig,
-      publicClient: result.network.publicClient,
-      walletClient: result.network.walletClient,
-      latestBlock$: result.network.latestBlock$,
-      storedBlockLogs$: result.network.storedBlockLogs$,
-      worldAddress: result.network.worldContract.address,
-      worldAbi: result.network.worldContract.abi,
-      write$: result.network.write$,
-      recsWorld: result.network.world,
-    });
-  }
-});

package/dist/templates/threejs/packages/contracts/worlds.json

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

package/dist/templates/vanilla/gitignore

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

package/dist/templates/vanilla/mprocs.yaml

@@ -1,13 +0,0 @@
-procs:
-  client:
-    cwd: packages/client
-    shell: pnpm run dev
-  contracts:
-    cwd: packages/contracts
-    shell: pnpm mud dev-contracts --rpc http://127.0.0.1:8545
-  anvil:
-    cwd: packages/contracts
-    shell: anvil --base-fee 0 --block-time 2
-  explorer:
-    cwd: packages/contracts
-    shell: pnpm explorer

package/dist/templates/vanilla/packages/client/gitignore

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

package/dist/templates/vanilla/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/dist/templates/vanilla/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/dist/templates/vanilla/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/dist/templates/vanilla/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/dist/templates/vanilla/packages/client/src/mud/world.ts

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

package/dist/templates/vanilla/packages/client/tsconfig.json

@@ -1,11 +0,0 @@
-{
-  "extends": "../../tsconfig.json",
-  "compilerOptions": {
-    "types": ["vite/client"],
-    "target": "ESNext",
-    "lib": ["ESNext", "DOM"],
-    "jsx": "react-jsx",
-    "jsxImportSource": "react"
-  },
-  "include": ["src"]
-}

package/dist/templates/vanilla/packages/contracts/.env

@@ -1,11 +0,0 @@
-# This .env file is for demonstration purposes only.
-#
-# This should usually be excluded via .gitignore and the env vars attached to
-# your deployment environment, but we're including this here for ease of local
-# development. Please do not commit changes to this file!
-#
-# Enable debug logs for MUD CLI
-DEBUG=mud:*
-#
-# Anvil default private key:
-PRIVATE_KEY=0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80

package/dist/templates/vanilla/packages/contracts/gitignore

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

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

@@ -1,13 +0,0 @@
-import { defineWorld } from "@latticexyz/world";
-
-export default defineWorld({
-  namespace: "app",
-  tables: {
-    Counter: {
-      schema: {
-        value: "uint32",
-      },
-      key: [],
-    },
-  },
-});

package/dist/templates/vanilla/packages/contracts/src/codegen/world/IIncrementSystem.sol

@@ -1,13 +0,0 @@
-// SPDX-License-Identifier: MIT
-pragma solidity >=0.8.24;
-
-/* Autogenerated file. Do not edit manually. */
-
-/**
- * @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 IIncrementSystem {
-  function app__increment() external returns (uint32);
-}

package/dist/templates/vanilla/packages/contracts/src/codegen/world/IWorld.sol

@@ -1,16 +0,0 @@
-// SPDX-License-Identifier: MIT
-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";
-
-/**
- * @title IWorld
- * @author MUD (https://mud.dev) by Lattice (https://lattice.xyz)
- * @notice This interface integrates all systems and associated function selectors
- * that are dynamically registered in the World during deployment.
- * @dev This is an autogenerated file; do not edit manually.
- */
-interface IWorld is IBaseWorld, IIncrementSystem {}

package/dist/templates/vanilla/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/dist/templates/vanilla/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);
-  }
-}

package/dist/templates/vanilla/packages/contracts/worlds.json

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