create-mud 2.0.0-alpha.1.21 → 2.0.0-alpha.1.211

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

@@ -0,0 +1,45 @@
+{
+  "name": "contracts",
+  "version": "0.0.0",
+  "private": true,
+  "license": "MIT",
+  "scripts": {
+    "build": "forge clean && forge build",
+    "deploy": "pnpm run initialize && mud deploy",
+    "deploy:hackathon": "pnpm run initialize && mud deploy --profile=hackathon-testnet",
+    "deploy:testnet": "pnpm run initialize && mud deploy --profile=lattice-testnet",
+    "dev": "pnpm mud dev-contracts --tsgenOutput ../client/src/mud",
+    "initialize": "pnpm run tablegen && pnpm run worldgen && pnpm run build && pnpm run worldtypes && pnpm run tsgen",
+    "lint": "pnpm run prettier && pnpm run solhint",
+    "prettier": "prettier --write 'src/**/*.sol'",
+    "solhint": "solhint --config ./.solhint.json 'src/**/*.sol' --fix",
+    "tablegen": "mud tablegen",
+    "test": "tsc --noEmit && mud test",
+    "tsgen": "mud tsgen --configPath mud.config.ts --out ../client/src/mud",
+    "worldgen": "mud worldgen",
+    "worldtypes": "rimraf types && typechain --target=ethers-v5 out/IWorld.sol/IWorld.json"
+  },
+  "dependencies": {
+    "@ethersproject/abi": "^5.7.0",
+    "@ethersproject/bytes": "^5.7.0",
+    "@ethersproject/providers": "^5.7.2",
+    "@latticexyz/cli": "{{mud-version}}",
+    "@latticexyz/schema-type": "{{mud-version}}",
+    "@latticexyz/std-contracts": "{{mud-version}}",
+    "@latticexyz/store": "{{mud-version}}",
+    "@latticexyz/world": "{{mud-version}}",
+    "ethers": "^5.7.2"
+  },
+  "devDependencies": {
+    "@typechain/ethers-v5": "^10.2.0",
+    "@types/node": "^18.15.11",
+    "ds-test": "https://github.com/dapphub/ds-test.git#c9ce3f25bde29fc5eb9901842bf02850dfd2d084",
+    "forge-std": "https://github.com/foundry-rs/forge-std.git#b4f121555729b3afb3c5ffccb62ff4b6e2818fd3",
+    "prettier": "^2.6.2",
+    "prettier-plugin-solidity": "^1.0.0-beta.19",
+    "solhint": "^3.3.7",
+    "solhint-config-mud": "{{mud-version}}",
+    "solhint-plugin-mud": "{{mud-version}}",
+    "typechain": "^8.1.1"
+  }
+}

package/dist/templates/threejs/packages/contracts/remappings.txt

@@ -0,0 +1,3 @@
+ds-test/=./node_modules/ds-test/src/
+forge-std/=./node_modules/forge-std/src/
+@latticexyz/=./node_modules/@latticexyz/

package/dist/templates/threejs/packages/contracts/src/codegen/Tables.sol

@@ -0,0 +1,6 @@
+// SPDX-License-Identifier: MIT
+pragma solidity >=0.8.0;
+
+/* Autogenerated file. Do not edit manually. */
+
+import { Position, PositionData, PositionTableId } from "./tables/Position.sol";

package/dist/templates/threejs/packages/contracts/src/codegen/tables/Position.sol

@@ -0,0 +1,263 @@
+// SPDX-License-Identifier: MIT
+pragma solidity >=0.8.0;
+
+/* Autogenerated file. Do not edit manually. */
+
+// Import schema type
+import { SchemaType } from "@latticexyz/schema-type/src/solidity/SchemaType.sol";
+
+// 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 { Schema, SchemaLib } from "@latticexyz/store/src/Schema.sol";
+import { PackedCounter, PackedCounterLib } from "@latticexyz/store/src/PackedCounter.sol";
+
+bytes32 constant _tableId = bytes32(abi.encodePacked(bytes16(""), bytes16("Position")));
+bytes32 constant PositionTableId = _tableId;
+
+struct PositionData {
+  int32 x;
+  int32 y;
+  int32 z;
+}
+
+library Position {
+  /** Get the table's schema */
+  function getSchema() internal pure returns (Schema) {
+    SchemaType[] memory _schema = new SchemaType[](3);
+    _schema[0] = SchemaType.INT32;
+    _schema[1] = SchemaType.INT32;
+    _schema[2] = SchemaType.INT32;
+
+    return SchemaLib.encode(_schema);
+  }
+
+  function getKeySchema() internal pure returns (Schema) {
+    SchemaType[] memory _schema = new SchemaType[](1);
+    _schema[0] = SchemaType.BYTES32;
+
+    return SchemaLib.encode(_schema);
+  }
+
+  /** Get the table's metadata */
+  function getMetadata() internal pure returns (string memory, string[] memory) {
+    string[] memory _fieldNames = new string[](3);
+    _fieldNames[0] = "x";
+    _fieldNames[1] = "y";
+    _fieldNames[2] = "z";
+    return ("Position", _fieldNames);
+  }
+
+  /** Register the table's schema */
+  function registerSchema() internal {
+    StoreSwitch.registerSchema(_tableId, getSchema(), getKeySchema());
+  }
+
+  /** Register the table's schema (using the specified store) */
+  function registerSchema(IStore _store) internal {
+    _store.registerSchema(_tableId, getSchema(), getKeySchema());
+  }
+
+  /** Set the table's metadata */
+  function setMetadata() internal {
+    (string memory _tableName, string[] memory _fieldNames) = getMetadata();
+    StoreSwitch.setMetadata(_tableId, _tableName, _fieldNames);
+  }
+
+  /** Set the table's metadata (using the specified store) */
+  function setMetadata(IStore _store) internal {
+    (string memory _tableName, string[] memory _fieldNames) = getMetadata();
+    _store.setMetadata(_tableId, _tableName, _fieldNames);
+  }
+
+  /** Get x */
+  function getX(bytes32 key) internal view returns (int32 x) {
+    bytes32[] memory _keyTuple = new bytes32[](1);
+    _keyTuple[0] = bytes32((key));
+
+    bytes memory _blob = StoreSwitch.getField(_tableId, _keyTuple, 0);
+    return (int32(uint32(Bytes.slice4(_blob, 0))));
+  }
+
+  /** Get x (using the specified store) */
+  function getX(IStore _store, bytes32 key) internal view returns (int32 x) {
+    bytes32[] memory _keyTuple = new bytes32[](1);
+    _keyTuple[0] = bytes32((key));
+
+    bytes memory _blob = _store.getField(_tableId, _keyTuple, 0);
+    return (int32(uint32(Bytes.slice4(_blob, 0))));
+  }
+
+  /** Set x */
+  function setX(bytes32 key, int32 x) internal {
+    bytes32[] memory _keyTuple = new bytes32[](1);
+    _keyTuple[0] = bytes32((key));
+
+    StoreSwitch.setField(_tableId, _keyTuple, 0, abi.encodePacked((x)));
+  }
+
+  /** Set x (using the specified store) */
+  function setX(IStore _store, bytes32 key, int32 x) internal {
+    bytes32[] memory _keyTuple = new bytes32[](1);
+    _keyTuple[0] = bytes32((key));
+
+    _store.setField(_tableId, _keyTuple, 0, abi.encodePacked((x)));
+  }
+
+  /** Get y */
+  function getY(bytes32 key) internal view returns (int32 y) {
+    bytes32[] memory _keyTuple = new bytes32[](1);
+    _keyTuple[0] = bytes32((key));
+
+    bytes memory _blob = StoreSwitch.getField(_tableId, _keyTuple, 1);
+    return (int32(uint32(Bytes.slice4(_blob, 0))));
+  }
+
+  /** Get y (using the specified store) */
+  function getY(IStore _store, bytes32 key) internal view returns (int32 y) {
+    bytes32[] memory _keyTuple = new bytes32[](1);
+    _keyTuple[0] = bytes32((key));
+
+    bytes memory _blob = _store.getField(_tableId, _keyTuple, 1);
+    return (int32(uint32(Bytes.slice4(_blob, 0))));
+  }
+
+  /** Set y */
+  function setY(bytes32 key, int32 y) internal {
+    bytes32[] memory _keyTuple = new bytes32[](1);
+    _keyTuple[0] = bytes32((key));
+
+    StoreSwitch.setField(_tableId, _keyTuple, 1, abi.encodePacked((y)));
+  }
+
+  /** Set y (using the specified store) */
+  function setY(IStore _store, bytes32 key, int32 y) internal {
+    bytes32[] memory _keyTuple = new bytes32[](1);
+    _keyTuple[0] = bytes32((key));
+
+    _store.setField(_tableId, _keyTuple, 1, abi.encodePacked((y)));
+  }
+
+  /** Get z */
+  function getZ(bytes32 key) internal view returns (int32 z) {
+    bytes32[] memory _keyTuple = new bytes32[](1);
+    _keyTuple[0] = bytes32((key));
+
+    bytes memory _blob = StoreSwitch.getField(_tableId, _keyTuple, 2);
+    return (int32(uint32(Bytes.slice4(_blob, 0))));
+  }
+
+  /** Get z (using the specified store) */
+  function getZ(IStore _store, bytes32 key) internal view returns (int32 z) {
+    bytes32[] memory _keyTuple = new bytes32[](1);
+    _keyTuple[0] = bytes32((key));
+
+    bytes memory _blob = _store.getField(_tableId, _keyTuple, 2);
+    return (int32(uint32(Bytes.slice4(_blob, 0))));
+  }
+
+  /** Set z */
+  function setZ(bytes32 key, int32 z) internal {
+    bytes32[] memory _keyTuple = new bytes32[](1);
+    _keyTuple[0] = bytes32((key));
+
+    StoreSwitch.setField(_tableId, _keyTuple, 2, abi.encodePacked((z)));
+  }
+
+  /** Set z (using the specified store) */
+  function setZ(IStore _store, bytes32 key, int32 z) internal {
+    bytes32[] memory _keyTuple = new bytes32[](1);
+    _keyTuple[0] = bytes32((key));
+
+    _store.setField(_tableId, _keyTuple, 2, abi.encodePacked((z)));
+  }
+
+  /** Get the full data */
+  function get(bytes32 key) internal view returns (PositionData memory _table) {
+    bytes32[] memory _keyTuple = new bytes32[](1);
+    _keyTuple[0] = bytes32((key));
+
+    bytes memory _blob = StoreSwitch.getRecord(_tableId, _keyTuple, getSchema());
+    return decode(_blob);
+  }
+
+  /** Get the full data (using the specified store) */
+  function get(IStore _store, bytes32 key) internal view returns (PositionData memory _table) {
+    bytes32[] memory _keyTuple = new bytes32[](1);
+    _keyTuple[0] = bytes32((key));
+
+    bytes memory _blob = _store.getRecord(_tableId, _keyTuple, getSchema());
+    return decode(_blob);
+  }
+
+  /** Set the full data using individual values */
+  function set(bytes32 key, int32 x, int32 y, int32 z) internal {
+    bytes memory _data = encode(x, y, z);
+
+    bytes32[] memory _keyTuple = new bytes32[](1);
+    _keyTuple[0] = bytes32((key));
+
+    StoreSwitch.setRecord(_tableId, _keyTuple, _data);
+  }
+
+  /** Set the full data using individual values (using the specified store) */
+  function set(IStore _store, bytes32 key, int32 x, int32 y, int32 z) internal {
+    bytes memory _data = encode(x, y, z);
+
+    bytes32[] memory _keyTuple = new bytes32[](1);
+    _keyTuple[0] = bytes32((key));
+
+    _store.setRecord(_tableId, _keyTuple, _data);
+  }
+
+  /** Set the full data using the data struct */
+  function set(bytes32 key, PositionData memory _table) internal {
+    set(key, _table.x, _table.y, _table.z);
+  }
+
+  /** Set the full data using the data struct (using the specified store) */
+  function set(IStore _store, bytes32 key, PositionData memory _table) internal {
+    set(_store, key, _table.x, _table.y, _table.z);
+  }
+
+  /** Decode the tightly packed blob using this table's schema */
+  function decode(bytes memory _blob) internal pure returns (PositionData memory _table) {
+    _table.x = (int32(uint32(Bytes.slice4(_blob, 0))));
+
+    _table.y = (int32(uint32(Bytes.slice4(_blob, 4))));
+
+    _table.z = (int32(uint32(Bytes.slice4(_blob, 8))));
+  }
+
+  /** Tightly pack full data using this table's schema */
+  function encode(int32 x, int32 y, int32 z) internal view returns (bytes memory) {
+    return abi.encodePacked(x, y, z);
+  }
+
+  /** Encode keys as a bytes32 array using this table's schema */
+  function encodeKeyTuple(bytes32 key) internal pure returns (bytes32[] memory _keyTuple) {
+    _keyTuple = new bytes32[](1);
+    _keyTuple[0] = bytes32((key));
+  }
+
+  /* Delete all data for given keys */
+  function deleteRecord(bytes32 key) internal {
+    bytes32[] memory _keyTuple = new bytes32[](1);
+    _keyTuple[0] = bytes32((key));
+
+    StoreSwitch.deleteRecord(_tableId, _keyTuple);
+  }
+
+  /* Delete all data for given keys (using the specified store) */
+  function deleteRecord(IStore _store, bytes32 key) internal {
+    bytes32[] memory _keyTuple = new bytes32[](1);
+    _keyTuple[0] = bytes32((key));
+
+    _store.deleteRecord(_tableId, _keyTuple);
+  }
+}

package/dist/templates/threejs/packages/contracts/src/codegen/world/IMoveSystem.sol

@@ -0,0 +1,8 @@
+// SPDX-License-Identifier: MIT
+pragma solidity >=0.8.0;
+
+/* Autogenerated file. Do not edit manually. */
+
+interface IMoveSystem {
+  function move(int32 x, int32 y, int32 z) external;
+}

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

@@ -0,0 +1,16 @@
+// SPDX-License-Identifier: MIT
+pragma solidity >=0.8.0;
+
+/* Autogenerated file. Do not edit manually. */
+
+import { IBaseWorld } from "@latticexyz/world/src/interfaces/IBaseWorld.sol";
+
+import { IMoveSystem } from "./IMoveSystem.sol";
+
+/**
+ * The IWorld interface includes all systems dynamically added to the World
+ * during the deploy process.
+ */
+interface IWorld is IBaseWorld, IMoveSystem {
+
+}

package/dist/templates/threejs/packages/contracts/src/systems/MoveSystem.sol

@@ -0,0 +1,25 @@
+// SPDX-License-Identifier: MIT
+pragma solidity >=0.8.0;
+import { System } from "@latticexyz/world/src/System.sol";
+import { Position, PositionData } from "../codegen/Tables.sol";
+
+function distance(PositionData memory a, PositionData memory b) pure returns (int32) {
+  int32 deltaX = a.x > b.x ? a.x - b.x : b.x - a.x;
+  int32 deltaY = a.y > b.y ? a.y - b.y : b.y - a.y;
+  int32 deltaZ = a.z > b.z ? a.z - b.z : b.z - a.z;
+
+  return deltaX + deltaY + deltaZ;
+}
+
+contract MoveSystem is System {
+  function move(int32 x, int32 y, int32 z) public {
+    bytes32 entityId = bytes32(uint256(uint160((_msgSender()))));
+
+    PositionData memory position = Position.get(entityId);
+    PositionData memory newPosition = PositionData(x, y, z);
+
+    require(distance(position, newPosition) == 1, "can only move to adjacent spaces");
+
+    Position.set(entityId, newPosition);
+  }
+}

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

@@ -0,0 +1,13 @@
+// Visit https://aka.ms/tsconfig.json for all config options
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "commonjs",
+    "strict": true,
+    "resolveJsonModule": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "moduleResolution": "node"
+  }
+}

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

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

package/dist/templates/threejs/pnpm-workspace.yaml

@@ -0,0 +1,2 @@
+packages:
+  - packages/*

package/dist/templates/vanilla/.eslintrc

@@ -0,0 +1,10 @@
+{
+  "root": true,
+  "parser": "@typescript-eslint/parser",
+  "plugins": ["@typescript-eslint"],
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/eslint-recommended",
+    "plugin:@typescript-eslint/recommended"
+  ]
+}

package/dist/templates/vanilla/.gitignore

@@ -0,0 +1 @@
+node_modules

package/dist/templates/vanilla/.vscode/extensions.json

@@ -0,0 +1,3 @@
+{
+  "recommendations": ["JuanBlanco.solidity"]
+}

package/dist/templates/vanilla/.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "solidity.monoRepoSupport": true
+}

package/dist/templates/vanilla/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "mud-template-vanilla",
+  "private": true,
+  "scripts": {
+    "build": "pnpm recursive run build",
+    "dev": "concurrently -n contracts,client -c cyan,magenta \"cd packages/contracts && pnpm run dev\" \"cd packages/client && pnpm run dev\"",
+    "dev:client": "pnpm --filter 'client' run dev",
+    "dev:contracts": "pnpm --filter 'contracts' dev",
+    "foundry:up": "curl -L https://foundry.paradigm.xyz | bash && bash $HOME/.foundry/bin/foundryup",
+    "initialize": "pnpm recursive run initialize",
+    "mud:up": "pnpm recursive exec mud set-version -v canary && pnpm install",
+    "prepare": "(forge --version || pnpm foundry:up)",
+    "test": "pnpm recursive run test"
+  },
+  "devDependencies": {
+    "@latticexyz/cli": "{{mud-version}}",
+    "@typescript-eslint/eslint-plugin": "5.46.1",
+    "@typescript-eslint/parser": "5.46.1",
+    "concurrently": "^8.0.1",
+    "eslint": "8.29.0",
+    "rimraf": "^3.0.2",
+    "typescript": "^4.9.5"
+  },
+  "engines": {
+    "node": "18.x",
+    "pnpm": "8.x"
+  }
+}

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

@@ -0,0 +1 @@
+VITE_CHAIN_ID=31337

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

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

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

@@ -0,0 +1,32 @@
+{
+  "name": "client",
+  "version": "0.0.0",
+  "private": true,
+  "license": "MIT",
+  "type": "module",
+  "scripts": {
+    "build": "vite build",
+    "dev": "wait-port localhost:8545 && vite",
+    "initialize": "pnpm build",
+    "preview": "vite preview",
+    "test": "tsc --noEmit"
+  },
+  "dependencies": {
+    "@ethersproject/providers": "^5.7.2",
+    "@latticexyz/common": "{{mud-version}}",
+    "@latticexyz/dev-tools": "{{mud-version}}",
+    "@latticexyz/network": "{{mud-version}}",
+    "@latticexyz/recs": "{{mud-version}}",
+    "@latticexyz/schema-type": "{{mud-version}}",
+    "@latticexyz/std-client": "{{mud-version}}",
+    "@latticexyz/utils": "{{mud-version}}",
+    "@latticexyz/world": "{{mud-version}}",
+    "@wagmi/chains": "^0.2.22",
+    "contracts": "workspace:*",
+    "ethers": "^5.7.2"
+  },
+  "devDependencies": {
+    "vite": "^4.2.1",
+    "wait-port": "^1.0.4"
+  }
+}

package/dist/templates/vanilla/packages/client/src/index.ts

@@ -0,0 +1,22 @@
+import { mount as mountDevTools } from "@latticexyz/dev-tools";
+import { setup } from "./mud/setup";
+
+const {
+  components,
+  systemCalls: { increment },
+} = await setup();
+
+// Components expose a stream that triggers when the component is updated.
+components.Counter.update$.subscribe((update) => {
+  const [nextValue, prevValue] = update.value;
+  console.log("Counter updated", update, { nextValue, prevValue });
+  document.getElementById("counter")!.innerHTML = String(nextValue?.value ?? "unset");
+});
+
+// Just for demonstration purposes: we create a global function that can be
+// called to invoke the Increment system contract via the world. (See IncrementSystem.sol.)
+(window as any).increment = async () => {
+  console.log("new counter value:", await increment());
+};
+
+mountDevTools();

package/dist/templates/vanilla/packages/client/src/mud/contractComponents.ts

@@ -0,0 +1,24 @@
+/* Autogenerated file. Do not edit manually. */
+
+import { TableId } from "@latticexyz/utils";
+import { defineComponent, Type as RecsType, World } from "@latticexyz/recs";
+
+export function defineContractComponents(world: World) {
+  return {
+    Counter: (() => {
+      const tableId = new TableId("", "Counter");
+      return defineComponent(
+        world,
+        {
+          value: RecsType.Number,
+        },
+        {
+          metadata: {
+            contractId: tableId.toHexString(),
+            tableId: tableId.toString(),
+          },
+        }
+      );
+    })(),
+  };
+}

package/dist/templates/vanilla/packages/client/src/mud/createClientComponents.ts

@@ -0,0 +1,10 @@
+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/createSystemCalls.ts

@@ -0,0 +1,21 @@
+import { getComponentValue } from "@latticexyz/recs";
+import { awaitStreamValue } from "@latticexyz/utils";
+import { ClientComponents } from "./createClientComponents";
+import { SetupNetworkResult } from "./setupNetwork";
+
+export type SystemCalls = ReturnType<typeof createSystemCalls>;
+
+export function createSystemCalls(
+  { worldSend, txReduced$, singletonEntity }: SetupNetworkResult,
+  { Counter }: ClientComponents
+) {
+  const increment = async () => {
+    const tx = await worldSend("increment", []);
+    await awaitStreamValue(txReduced$, (txHash) => txHash === tx.hash);
+    return getComponentValue(Counter, singletonEntity);
+  };
+
+  return {
+    increment,
+  };
+}

package/dist/templates/vanilla/packages/client/src/mud/getNetworkConfig.ts

@@ -0,0 +1,53 @@
+import { SetupContractConfig, getBurnerWallet } from "@latticexyz/std-client";
+import worldsJson from "contracts/worlds.json";
+import { supportedChains } from "./supportedChains";
+
+const worlds = worldsJson as Partial<Record<string, { address: string; blockNumber?: number }>>;
+
+type NetworkConfig = SetupContractConfig & {
+  privateKey: string;
+  faucetServiceUrl?: string;
+  snapSync?: boolean;
+};
+
+export async function getNetworkConfig(): Promise<NetworkConfig> {
+  const params = new URLSearchParams(window.location.search);
+
+  const chainId = Number(params.get("chainId") || import.meta.env.VITE_CHAIN_ID || 31337);
+  const chainIndex = supportedChains.findIndex((c) => c.id === chainId);
+  const chain = supportedChains[chainIndex];
+  if (!chain) {
+    throw new Error(`Chain ${chainId} not found`);
+  }
+
+  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\`?`);
+  }
+
+  const initialBlockNumber = params.has("initialBlockNumber")
+    ? Number(params.get("initialBlockNumber"))
+    : world?.blockNumber ?? -1; // -1 will attempt to find the block number from RPC
+
+  return {
+    clock: {
+      period: 1000,
+      initialTime: 0,
+      syncInterval: 5000,
+    },
+    provider: {
+      chainId,
+      jsonRpcUrl: params.get("rpc") ?? chain.rpcUrls.default.http[0],
+      wsRpcUrl: params.get("wsRpc") ?? chain.rpcUrls.default.webSocket?.[0],
+    },
+    privateKey: getBurnerWallet().value,
+    chainId,
+    modeUrl: params.get("mode") ?? chain.modeUrl,
+    faucetServiceUrl: params.get("faucet") ?? chain.faucetUrl,
+    worldAddress,
+    initialBlockNumber,
+    snapSync: params.get("snapSync") === "true",
+    disableCache: params.get("cache") === "false",
+  };
+}

package/dist/templates/vanilla/packages/client/src/mud/setup.ts

@@ -0,0 +1,16 @@
+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,
+  };
+}