feat: move forge build + abi + abi-ts to out (latticexyz#1483)

Co-authored-by: alvarius <[email protected]>

Author: frolic

.changeset/many-pumpkins-cry.md

@@ -0,0 +1,18 @@
+---
+"@latticexyz/store": major
+"@latticexyz/world": major
+---
+
+Store and World contract ABIs are now exported from the `out` directory. You'll need to update your imports like:
+
+```diff
+- import IBaseWorldAbi from "@latticexyz/world/abi/IBaseWorld.sol/IBaseWorldAbi.json";
++ import IBaseWorldAbi from "@latticexyz/world/out/IBaseWorld.sol/IBaseWorldAbi.json";
+```
+
+`MudTest.sol` was also moved to the World package. You can update your import like:
+
+```diff
+- import { MudTest } from "@latticexyz/store/src/MudTest.sol";
++ import { MudTest } from "@latticexyz/world/test/MudTest.t.sol";
+```

.changeset/modern-trains-remain.md

@@ -0,0 +1,19 @@
+---
+"create-mud": minor
+---
+
+Templates now use `out` for their `forge build` artifacts, including ABIs. If you have a project created from a previous template, you can update your `packages/contracts/package.json` with:
+
+```diff
+- "build:abi": "rimraf abi && forge build --extra-output-files abi --out abi --skip test script MudTest.sol",
+- "build:abi-ts": "mud abi-ts --input 'abi/IWorld.sol/IWorld.abi.json' && prettier --write '**/*.abi.json.d.ts'",
++ "build:abi": "forge clean && forge build --skip test script",
++ "build:abi-ts": "mud abi-ts && prettier --write '**/*.abi.json.d.ts'",
+```
+
+And your `packages/client/src/mud/setupNetwork` with:
+
+```diff
+- import IWorldAbi from "contracts/abi/IWorld.sol/IWorld.abi.json";
++ import IWorldAbi from "contracts/out/IWorld.sol/IWorld.abi.json";
+```

.changeset/sweet-kiwis-unite.md

@@ -0,0 +1,5 @@
+---
+"@latticexyz/cli": patch
+---
+
+`deploy` and `dev-contracts` CLI commands now use `forge build --skip test script` before deploying and run `mud abi-ts` to generate strong types for ABIs.

.dockerignore

@@ -8,6 +8,5 @@ dist
 **/cache/
 **/bindings/
 **/artifacts/
-**/abi/
 **/broadcast/
 **/deploys/

.gitattributes

@@ -1,4 +1,2 @@
 # suppress diffs for codegen in PRs
-**/abi/**/*.json linguist-generated=true
-**/abi/**/*.json.d.ts linguist-generated=true
 **/codegen/**/*.sol linguist-generated=true

e2e/packages/client-vanilla/src/mud/setupNetwork.ts

@@ -3,7 +3,7 @@ import { createFaucetService } from "@latticexyz/services/faucet";
 import { encodeEntity, syncToRecs } from "@latticexyz/store-sync/recs";
 import { getNetworkConfig } from "./getNetworkConfig";
 import { world } from "./world";
-import IWorldAbi from "contracts/abi/IWorld.sol/IWorld.abi.json";
+import IWorldAbi from "contracts/out/IWorld.sol/IWorld.abi.json";
 import { createBurnerAccount, createContract, transportObserver } from "@latticexyz/common";
 import mudConfig from "contracts/mud.config";
 

e2e/packages/contracts/.gitignore

@@ -3,7 +3,6 @@ cache/
 node_modules/
 bindings/
 artifacts/
-abi/
 broadcast/
 
 # Ignore all deploy artifacts

e2e/packages/contracts/package.json

@@ -5,11 +5,11 @@
   "license": "MIT",
   "scripts": {
     "build": "pnpm run build:mud && pnpm run build:abi && pnpm run build:abi-ts",
-    "build:abi": "forge build --extra-output-files abi --out abi --skip test script MudTest.sol",
-    "build:abi-ts": "mud abi-ts --input 'abi/IWorld.sol/IWorld.abi.json' && prettier --write '**/*.abi.json.d.ts'",
+    "build:abi": "forge build --skip test script",
+    "build:abi-ts": "mud abi-ts && prettier --write '**/*.abi.json.d.ts'",
     "build:mud": "mud tablegen && mud worldgen",
     "clean": "pnpm run clean:abi && pnpm run clean:mud",
-    "clean:abi": "rimraf abi",
+    "clean:abi": "forge clean",
     "clean:mud": "rimraf src/codegen",
     "deploy:local": "mud deploy",
     "test": "mud test",

e2e/packages/contracts/test/Worldgen.t.sol

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: MIT
 pragma solidity >=0.8.0;
 
-import { MudTest } from "@latticexyz/store/src/MudTest.sol";
+import { MudTest } from "@latticexyz/world/test/MudTest.t.sol";
 
 import { ICustomErrorsSystem } from "../src/codegen/world/ICustomErrorsSystem.sol";
 import { Position } from "../src/CustomTypes.sol";

e2e/packages/sync-test/data/callWorld.ts

@@ -1,5 +1,5 @@
 import { Page } from "@playwright/test";
-import IWorldAbi from "../../contracts/abi/IWorld.sol/IWorld.abi.json";
+import IWorldAbi from "../../contracts/out/IWorld.sol/IWorld.abi.json";
 import { GetContractReturnType, PublicClient, WalletClient } from "viem";
 import { AbiParametersToPrimitiveTypes, ExtractAbiFunction, ExtractAbiFunctionNames } from "abitype";
 

e2e/packages/test-data/generate-test-data.ts

@@ -16,7 +16,7 @@ import { mudFoundry } from "@latticexyz/common/chains";
 import { createContract } from "@latticexyz/common";
 import { storeEventsAbi } from "@latticexyz/store";
 import { privateKeyToAccount } from "viem/accounts";
-import IWorldAbi from "../contracts/abi/IWorld.sol/IWorld.abi.json";
+import IWorldAbi from "../contracts/out/IWorld.sol/IWorld.abi.json";
 
 const logsFilename = path.join(path.dirname(fileURLToPath(import.meta.url)), `../../../test-data/world-logs.json`);
 

examples/minimal/packages/client-phaser/src/mud/setupNetwork.ts

@@ -3,7 +3,7 @@ import { createFaucetService } from "@latticexyz/services/faucet";
 import { encodeEntity, syncToRecs } from "@latticexyz/store-sync/recs";
 import { getNetworkConfig } from "./getNetworkConfig";
 import { world } from "./world";
-import IWorldAbi from "contracts/abi/IWorld.sol/IWorld.abi.json";
+import IWorldAbi from "contracts/out/IWorld.sol/IWorld.abi.json";
 import { createBurnerAccount, createContract, transportObserver, ContractWrite } from "@latticexyz/common";
 import { Subject, share } from "rxjs";
 import mudConfig from "contracts/mud.config";

examples/minimal/packages/client-react/src/mud/setupNetwork.ts

@@ -3,7 +3,7 @@ import { createFaucetService } from "@latticexyz/services/faucet";
 import { encodeEntity, syncToRecs } from "@latticexyz/store-sync/recs";
 import { getNetworkConfig } from "./getNetworkConfig";
 import { world } from "./world";
-import IWorldAbi from "contracts/abi/IWorld.sol/IWorld.abi.json";
+import IWorldAbi from "contracts/out/IWorld.sol/IWorld.abi.json";
 import { ContractWrite, createBurnerAccount, createContract, transportObserver } from "@latticexyz/common";
 import { Subject, share } from "rxjs";
 import mudConfig from "contracts/mud.config";

examples/minimal/packages/client-vanilla/src/mud/setupNetwork.ts

@@ -3,7 +3,7 @@ import { createFaucetService } from "@latticexyz/services/faucet";
 import { encodeEntity, syncToRecs } from "@latticexyz/store-sync/recs";
 import { getNetworkConfig } from "./getNetworkConfig";
 import { world } from "./world";
-import IWorldAbi from "contracts/abi/IWorld.sol/IWorld.abi.json";
+import IWorldAbi from "contracts/out/IWorld.sol/IWorld.abi.json";
 import { createBurnerAccount, createContract, transportObserver, ContractWrite } from "@latticexyz/common";
 import { Subject, share } from "rxjs";
 import mudConfig from "contracts/mud.config";

examples/minimal/packages/contracts/.gitignore

@@ -3,7 +3,6 @@ cache/
 node_modules/
 bindings/
 artifacts/
-abi/
 broadcast/
 
 # Ignore MUD deploy artifacts

examples/minimal/packages/contracts/package.json

@@ -5,8 +5,8 @@
   "license": "MIT",
   "scripts": {
     "build": "pnpm run build:mud && pnpm run build:abi && pnpm run build:abi-ts",
-    "build:abi": "rimraf abi && forge build --extra-output-files abi --out abi --skip test script MudTest.sol",
-    "build:abi-ts": "mud abi-ts --input 'abi/IWorld.sol/IWorld.abi.json' && prettier --write '**/*.abi.json.d.ts'",
+    "build:abi": "forge clean && forge build --skip test script",
+    "build:abi-ts": "mud abi-ts && prettier --write '**/*.abi.json.d.ts'",
     "build:mud": "mud tablegen && mud worldgen",
     "deploy:local": "pnpm run build && mud deploy",
     "deploy:testnet": "pnpm run build && mud deploy --profile=lattice-testnet",

examples/minimal/packages/contracts/test/ChatNamespaced.t.sol

@@ -2,7 +2,7 @@
 pragma solidity >=0.8.0;
 
 import "forge-std/Test.sol";
-import { MudTest } from "@latticexyz/store/src/MudTest.sol";
+import { MudTest } from "@latticexyz/world/test/MudTest.t.sol";
 import { getKeysWithValue } from "@latticexyz/world/src/modules/keyswithvalue/getKeysWithValue.sol";
 import { StoreCore } from "@latticexyz/store/src/StoreCore.sol";
 

examples/minimal/packages/contracts/test/CounterTest.t.sol

@@ -2,7 +2,7 @@
 pragma solidity >=0.8.0;
 
 import "forge-std/Test.sol";
-import { MudTest } from "@latticexyz/store/src/MudTest.sol";
+import { MudTest } from "@latticexyz/world/test/MudTest.t.sol";
 import { getKeysWithValue } from "@latticexyz/world/src/modules/keyswithvalue/getKeysWithValue.sol";
 
 import { IWorld } from "../src/codegen/world/IWorld.sol";

examples/minimal/packages/contracts/test/StructTest.t.sol

@@ -2,7 +2,7 @@
 pragma solidity >=0.8.0;
 
 import "forge-std/Test.sol";
-import { MudTest } from "@latticexyz/store/src/MudTest.sol";
+import { MudTest } from "@latticexyz/world/test/MudTest.t.sol";
 import { getKeysWithValue } from "@latticexyz/world/src/modules/keyswithvalue/getKeysWithValue.sol";
 
 import { IWorld } from "../src/codegen/world/IWorld.sol";

examples/minimal/packages/plugin-example/.gitignore

@@ -3,4 +3,3 @@ out/
 cache/
 node_modules/
 artifacts/
-abi/

packages/cli/foundry.toml

@@ -10,3 +10,7 @@ allow_paths = ["../../node_modules", "../"]
 src = "contracts/src"
 out = "contracts/out"
 test = "contracts/test"
+extra_output_files = [
+  "abi",
+  "evm.bytecode"
+]

packages/cli/src/commands/dev-contracts.ts

@@ -141,12 +141,10 @@ const commandModule: CommandModule<Options, Options> = {
       await worldgenHandler({ config, clean: true, srcDir: srcDirectory });
 
       // Build the contracts
-      await forge(["build"]);
+      await forge(["build", "--skip", "test", "script"]);
 
-      // Generate TS-friendly ABI files
-      // We rebuild into a separate dir to have a clean set of ABIs without test/script contracts
-      await forge(["build", "--extra-output-files", "abi", "--out", "abi", "--skip", "test", "script", "MudTest.sol"]);
-      await execa("mud", ["abi-ts"]);
+      // Generate TS type definitions for ABIs
+      await execa("mud", ["abi-ts"], { stdio: "inherit" });
     }
 
     /** Run after codegen if either mud config or contracts changed */

packages/cli/src/commands/trace.ts

@@ -7,7 +7,7 @@ import { MUDError } from "@latticexyz/common/errors";
 import { cast, getRpcUrl, getSrcDirectory } from "@latticexyz/common/foundry";
 import { StoreConfig } from "@latticexyz/store";
 import { resolveWorldConfig, WorldConfig } from "@latticexyz/world";
-import IBaseWorldData from "@latticexyz/world/abi/IBaseWorld.sol/IBaseWorld.json" assert { type: "json" };
+import IBaseWorldData from "@latticexyz/world/out/IBaseWorld.sol/IBaseWorld.json" assert { type: "json" };
 import worldConfig from "@latticexyz/world/mud.config.js";
 import { tableIdToHex } from "@latticexyz/common";
 import { getChainId, getExistingContracts } from "../utils";

packages/cli/src/utils/deploy.ts

@@ -11,12 +11,12 @@ import { encodeSchema, getStaticByteLength } from "@latticexyz/schema-type/depre
 import { StoreConfig } from "@latticexyz/store";
 import { resolveAbiOrUserType } from "@latticexyz/store/codegen";
 import { WorldConfig, resolveWorldConfig } from "@latticexyz/world";
-import IBaseWorldData from "@latticexyz/world/abi/IBaseWorld.sol/IBaseWorld.json" assert { type: "json" };
-import WorldData from "@latticexyz/world/abi/World.sol/World.json" assert { type: "json" };
-import CoreModuleData from "@latticexyz/world/abi/CoreModule.sol/CoreModule.json" assert { type: "json" };
-import KeysWithValueModuleData from "@latticexyz/world/abi/KeysWithValueModule.sol/KeysWithValueModule.json" assert { type: "json" };
-import KeysInTableModuleData from "@latticexyz/world/abi/KeysInTableModule.sol/KeysInTableModule.json" assert { type: "json" };
-import UniqueEntityModuleData from "@latticexyz/world/abi/UniqueEntityModule.sol/UniqueEntityModule.json" assert { type: "json" };
+import IBaseWorldData from "@latticexyz/world/out/IBaseWorld.sol/IBaseWorld.json" assert { type: "json" };
+import WorldData from "@latticexyz/world/out/World.sol/World.json" assert { type: "json" };
+import CoreModuleData from "@latticexyz/world/out/CoreModule.sol/CoreModule.json" assert { type: "json" };
+import KeysWithValueModuleData from "@latticexyz/world/out/KeysWithValueModule.sol/KeysWithValueModule.json" assert { type: "json" };
+import KeysInTableModuleData from "@latticexyz/world/out/KeysInTableModule.sol/KeysInTableModule.json" assert { type: "json" };
+import UniqueEntityModuleData from "@latticexyz/world/out/UniqueEntityModule.sol/UniqueEntityModule.json" assert { type: "json" };
 import { tableIdToHex } from "@latticexyz/common";
 import { fieldLayoutToHex } from "@latticexyz/protocol-parser";
 

packages/cli/src/utils/deployHandler.ts

@@ -9,6 +9,7 @@ import { forge, getRpcUrl, getSrcDirectory } from "@latticexyz/common/foundry";
 import { existsSync, mkdirSync, readFileSync, writeFileSync } from "fs";
 import { getChainId } from "../utils/getChainId";
 import { getExistingContracts } from "./getExistingContracts";
+import { execa } from "execa";
 
 export type DeployOptions = {
   configPath?: string;
@@ -37,10 +38,15 @@ export async function deployHandler(args: DeployOptions) {
     )
   );
 
-  if (clean) await forge(["clean"], { profile });
+  if (clean) {
+    await forge(["clean"], { profile });
+  }
 
   // Run forge build
-  if (!skipBuild) await forge(["build"], { profile });
+  if (!skipBuild) {
+    await forge(["build", "--skip", "test", "script"], { profile });
+    await execa("mud", ["abi-ts"], { stdio: "inherit" });
+  }
 
   // Get a list of all contract names
   const srcDir = args?.srcDir ?? (await getSrcDirectory());

packages/gas-report/.gitignore

@@ -1,5 +1,4 @@
 cache
-abi
 out
 docs
 _docs

packages/gas-report/.npmignore

@@ -1,6 +1,7 @@
 *
 
-!abi/**
+!out/**/*.abi.json
+!out/**/*.abi.json.d.ts
 !src/**
 !ts/**
 !package.json

packages/gas-report/foundry.toml

@@ -9,3 +9,7 @@ allow_paths= ["../../node_modules"]
 src = "src"
 out = "out"
 bytecode_hash = "none"
+extra_output_files = [
+  "abi",
+  "evm.bytecode"
+]

packages/noise/foundry.toml

@@ -8,3 +8,7 @@ verbosity = 2
 allow_paths = ["../../node_modules"]
 src = "contracts"
 out = "out"
+extra_output_files = [
+  "abi",
+  "evm.bytecode"
+]

packages/schema-type/.gitignore

@@ -1,5 +1,4 @@
 cache
-abi
 out
 dist
 docs

packages/schema-type/foundry.toml

@@ -9,3 +9,7 @@ allow_paths = ["../../node_modules"]
 src = "src/solidity"
 out = "out/solidity"
 test = "test/solidity"
+extra_output_files = [
+  "abi",
+  "evm.bytecode"
+]

packages/store/.gitignore

@@ -7,7 +7,3 @@ artifacts
 yarn-error.log
 API
 dist
-
-# only check in ABIs
-abi/**/*.json
-!abi/**/*.abi.json

packages/store/.npmignore

@@ -1,6 +1,7 @@
 *
 
-!abi/**
+!out/**/*.abi.json
+!out/**/*.abi.json.d.ts
 !src/**
 !ts/**
 !package.json