refactor(world,world-modules): move optional modules from world to …

…`world-modules` package (#1591)

Co-authored-by: Kevin Ingersoll <[email protected]>

.changeset/unlucky-cups-fetch.md

@@ -0,0 +1,8 @@
+---
+"@latticexyz/cli": patch
+"@latticexyz/world": major
+"@latticexyz/world-modules": major
+---
+
+All optional modules have been moved from `@latticexyz/world` to `@latticexyz/world-modules`.
+If you're using the MUD CLI, the import is already updated and no changes are necessary.

examples/minimal/packages/contracts/package.json

@@ -24,6 +24,7 @@
     "@latticexyz/schema-type": "link:../../../../packages/schema-type",
     "@latticexyz/store": "link:../../../../packages/store",
     "@latticexyz/world": "link:../../../../packages/world",
+    "@latticexyz/world-modules": "link:../../../../packages/world-modules",
     "@solidstate/contracts": "^0.0.52",
     "@types/node": "^18.15.11",
     "ds-test": "https://github.com/dapphub/ds-test.git#e282159d5170298eb2455a6c05280ab5a73a4ef0",

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

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

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

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

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

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

packages/cli/package.json

@@ -44,6 +44,7 @@
     "@latticexyz/store": "workspace:*",
     "@latticexyz/utils": "workspace:*",
     "@latticexyz/world": "workspace:*",
+    "@latticexyz/world-modules": "workspace:*",
     "chalk": "^5.0.1",
     "chokidar": "^3.5.3",
     "dotenv": "^16.0.3",

packages/cli/src/utils/modules/constants.ts

@@ -1,6 +1,6 @@
-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 KeysWithValueModuleData from "@latticexyz/world-modules/out/KeysWithValueModule.sol/KeysWithValueModule.json" assert { type: "json" };
+import KeysInTableModuleData from "@latticexyz/world-modules/out/KeysInTableModule.sol/KeysInTableModule.json" assert { type: "json" };
+import UniqueEntityModuleData from "@latticexyz/world-modules/out/UniqueEntityModule.sol/UniqueEntityModule.json" assert { type: "json" };
 import { ContractCode } from "../utils/types";
 
 // These modules are always deployed

packages/world-modules/.gitignore

@@ -0,0 +1,9 @@
+cache
+out
+docs
+_docs
+DOCS.md
+artifacts
+yarn-error.log
+API
+dist

packages/world-modules/.npmignore

@@ -0,0 +1,10 @@
+*
+
+!out/**/*.json
+!out/**/*.abi.json
+!out/**/*.abi.json.d.ts
+!src/**
+!ts/**
+!package.json
+!README.md
+!dist/**

packages/world-modules/.solhint.json

@@ -0,0 +1,8 @@
+{
+  "extends": "solhint:recommended",
+  "rules": {
+    "compiler-version": ["error", ">=0.8.0"],
+    "avoid-low-level-calls": "off",
+    "func-visibility": ["warn", { "ignoreConstructors": true }]
+  }
+}

packages/world-modules/CHANGELOG.md

@@ -0,0 +1 @@
+# Change Log

packages/world-modules/README.md

@@ -0,0 +1 @@
+# World modules

packages/world-modules/foundry.toml

@@ -0,0 +1,15 @@
+[profile.default]
+solc = "0.8.21"
+ffi = false
+fuzz_runs = 256
+optimizer = true
+optimizer_runs = 3000
+verbosity = 2
+allow_paths = ["../../node_modules", "../"]
+src = "src"
+out = "out"
+bytecode_hash = "none"
+extra_output_files = [
+  "abi",
+  "evm.bytecode"
+]

packages/world-modules/gas-report.json

@@ -0,0 +1,242 @@
+[
+  {
+    "file": "test/KeysInTableModule.t.sol",
+    "test": "testInstallComposite",
+    "name": "install keys in table module",
+    "gasUsed": 1408400
+  },
+  {
+    "file": "test/KeysInTableModule.t.sol",
+    "test": "testInstallGas",
+    "name": "install keys in table module",
+    "gasUsed": 1408400
+  },
+  {
+    "file": "test/KeysInTableModule.t.sol",
+    "test": "testInstallGas",
+    "name": "set a record on a table with keysInTableModule installed",
+    "gasUsed": 159030
+  },
+  {
+    "file": "test/KeysInTableModule.t.sol",
+    "test": "testInstallSingleton",
+    "name": "install keys in table module",
+    "gasUsed": 1408400
+  },
+  {
+    "file": "test/KeysInTableModule.t.sol",
+    "test": "testSetAndDeleteRecordHookCompositeGas",
+    "name": "install keys in table module",
+    "gasUsed": 1408400
+  },
+  {
+    "file": "test/KeysInTableModule.t.sol",
+    "test": "testSetAndDeleteRecordHookCompositeGas",
+    "name": "change a composite record on a table with keysInTableModule installed",
+    "gasUsed": 22571
+  },
+  {
+    "file": "test/KeysInTableModule.t.sol",
+    "test": "testSetAndDeleteRecordHookCompositeGas",
+    "name": "delete a composite record on a table with keysInTableModule installed",
+    "gasUsed": 156371
+  },
+  {
+    "file": "test/KeysInTableModule.t.sol",
+    "test": "testSetAndDeleteRecordHookGas",
+    "name": "install keys in table module",
+    "gasUsed": 1408400
+  },
+  {
+    "file": "test/KeysInTableModule.t.sol",
+    "test": "testSetAndDeleteRecordHookGas",
+    "name": "change a record on a table with keysInTableModule installed",
+    "gasUsed": 21293
+  },
+  {
+    "file": "test/KeysInTableModule.t.sol",
+    "test": "testSetAndDeleteRecordHookGas",
+    "name": "delete a record on a table with keysInTableModule installed",
+    "gasUsed": 85329
+  },
+  {
+    "file": "test/KeysWithValueModule.t.sol",
+    "test": "testGetKeysWithValueGas",
+    "name": "install keys with value module",
+    "gasUsed": 649560
+  },
+  {
+    "file": "test/KeysWithValueModule.t.sol",
+    "test": "testGetKeysWithValueGas",
+    "name": "Get list of keys with a given value",
+    "gasUsed": 5712
+  },
+  {
+    "file": "test/KeysWithValueModule.t.sol",
+    "test": "testGetTargetTableId",
+    "name": "compute the target table selector",
+    "gasUsed": 2624
+  },
+  {
+    "file": "test/KeysWithValueModule.t.sol",
+    "test": "testInstall",
+    "name": "install keys with value module",
+    "gasUsed": 649560
+  },
+  {
+    "file": "test/KeysWithValueModule.t.sol",
+    "test": "testInstall",
+    "name": "set a record on a table with KeysWithValueModule installed",
+    "gasUsed": 135698
+  },
+  {
+    "file": "test/KeysWithValueModule.t.sol",
+    "test": "testSetAndDeleteRecordHook",
+    "name": "install keys with value module",
+    "gasUsed": 649560
+  },
+  {
+    "file": "test/KeysWithValueModule.t.sol",
+    "test": "testSetAndDeleteRecordHook",
+    "name": "change a record on a table with KeysWithValueModule installed",
+    "gasUsed": 104082
+  },
+  {
+    "file": "test/KeysWithValueModule.t.sol",
+    "test": "testSetAndDeleteRecordHook",
+    "name": "delete a record on a table with KeysWithValueModule installed",
+    "gasUsed": 36693
+  },
+  {
+    "file": "test/KeysWithValueModule.t.sol",
+    "test": "testSetField",
+    "name": "install keys with value module",
+    "gasUsed": 649560
+  },
+  {
+    "file": "test/KeysWithValueModule.t.sol",
+    "test": "testSetField",
+    "name": "set a field on a table with KeysWithValueModule installed",
+    "gasUsed": 146907
+  },
+  {
+    "file": "test/KeysWithValueModule.t.sol",
+    "test": "testSetField",
+    "name": "change a field on a table with KeysWithValueModule installed",
+    "gasUsed": 111666
+  },
+  {
+    "file": "test/query.t.sol",
+    "test": "testCombinedHasHasValueNotQuery",
+    "name": "CombinedHasHasValueNotQuery",
+    "gasUsed": 105109
+  },
+  {
+    "file": "test/query.t.sol",
+    "test": "testCombinedHasHasValueQuery",
+    "name": "CombinedHasHasValueQuery",
+    "gasUsed": 53579
+  },
+  {
+    "file": "test/query.t.sol",
+    "test": "testCombinedHasNotQuery",
+    "name": "CombinedHasNotQuery",
+    "gasUsed": 131374
+  },
+  {
+    "file": "test/query.t.sol",
+    "test": "testCombinedHasQuery",
+    "name": "CombinedHasQuery",
+    "gasUsed": 84497
+  },
+  {
+    "file": "test/query.t.sol",
+    "test": "testCombinedHasValueNotQuery",
+    "name": "CombinedHasValueNotQuery",
+    "gasUsed": 85116
+  },
+  {
+    "file": "test/query.t.sol",
+    "test": "testCombinedHasValueQuery",
+    "name": "CombinedHasValueQuery",
+    "gasUsed": 15705
+  },
+  {
+    "file": "test/query.t.sol",
+    "test": "testHasQuery",
+    "name": "HasQuery",
+    "gasUsed": 18882
+  },
+  {
+    "file": "test/query.t.sol",
+    "test": "testHasQuery1000Keys",
+    "name": "HasQuery with 1000 keys",
+    "gasUsed": 5804585
+  },
+  {
+    "file": "test/query.t.sol",
+    "test": "testHasQuery100Keys",
+    "name": "HasQuery with 100 keys",
+    "gasUsed": 541538
+  },
+  {
+    "file": "test/query.t.sol",
+    "test": "testHasValueQuery",
+    "name": "HasValueQuery",
+    "gasUsed": 7521
+  },
+  {
+    "file": "test/query.t.sol",
+    "test": "testNotValueQuery",
+    "name": "NotValueQuery",
+    "gasUsed": 47175
+  },
+  {
+    "file": "test/StandardDelegationsModule.t.sol",
+    "test": "testCallFromCallboundDelegation",
+    "name": "register a callbound delegation",
+    "gasUsed": 117579
+  },
+  {
+    "file": "test/StandardDelegationsModule.t.sol",
+    "test": "testCallFromCallboundDelegation",
+    "name": "call a system via a callbound delegation",
+    "gasUsed": 36737
+  },
+  {
+    "file": "test/StandardDelegationsModule.t.sol",
+    "test": "testCallFromTimeboundDelegation",
+    "name": "register a timebound delegation",
+    "gasUsed": 112073
+  },
+  {
+    "file": "test/StandardDelegationsModule.t.sol",
+    "test": "testCallFromTimeboundDelegation",
+    "name": "call a system via a timebound delegation",
+    "gasUsed": 26822
+  },
+  {
+    "file": "test/UniqueEntityModule.t.sol",
+    "test": "testInstall",
+    "name": "install unique entity module",
+    "gasUsed": 676208
+  },
+  {
+    "file": "test/UniqueEntityModule.t.sol",
+    "test": "testInstall",
+    "name": "get a unique entity nonce (non-root module)",
+    "gasUsed": 51180
+  },
+  {
+    "file": "test/UniqueEntityModule.t.sol",
+    "test": "testInstallRoot",
+    "name": "installRoot unique entity module",
+    "gasUsed": 643472
+  },
+  {
+    "file": "test/UniqueEntityModule.t.sol",
+    "test": "testInstallRoot",
+    "name": "get a unique entity nonce (root module)",
+    "gasUsed": 51180
+  }
+]