@latticexyz/world 2.0.0-main-e241c056 → 2.0.0-main-29c3f508

package/dist/chunk-BZ6EK2LH.js

@@ -0,0 +1,2 @@
+import{STORE_NAME_MAX_LENGTH as d,UnrecognizedSystemErrorFactory as y}from"@latticexyz/config";function u(t,s){let n=s?.filter(e=>e.endsWith("System")&&e!=="System"&&!e.match(/^I[A-Z]/))??[],c=Object.keys(t.systems);if(s){for(let e of c)if(!s.includes(e)||e==="World")throw y(["systems",e],e)}return{systems:[...new Set([...n,...c])].filter(e=>!t.excludeSystems.includes(e)).reduce((e,o)=>({...e,[o]:f(o,t.systems[o],s)}),{})}}function f(t,s,n){let c=(s?.name??t).slice(0,d),i=s?.registerFunctionSelectors??!0,m=s?.openAccess??!0,e=[],o=[],l=s&&!s.openAccess?s.accessList:[];for(let r of l)if(r.startsWith("0x"))e.push(r);else{if(n&&!n.includes(r))throw y(["systems",t,"accessList"],r);o.push(r)}return{name:c,registerFunctionSelectors:i,openAccess:m,accessListAddresses:e,accessListSystems:o}}export{u as a,f as b};
+//# sourceMappingURL=chunk-BZ6EK2LH.js.map

package/dist/chunk-BZ6EK2LH.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../ts/config/resolveWorldConfig.ts"],"sourcesContent":["import { STORE_NAME_MAX_LENGTH, UnrecognizedSystemErrorFactory } from \"@latticexyz/config\";\nimport { StoreConfig } from \"@latticexyz/store\";\nimport { SystemConfig, WorldConfig } from \"./types\";\n\nexport type ResolvedSystemConfig = ReturnType<typeof resolveSystemConfig>;\n\nexport type ResolvedWorldConfig = ReturnType<typeof resolveWorldConfig>;\n\n/**\n * Resolves the world config by combining the default and overridden system configs,\n * filtering out excluded systems, validate system names refer to existing contracts, and\n * splitting the access list into addresses and system names.\n */\nexport function resolveWorldConfig(config: StoreConfig & WorldConfig, existingContracts?: string[]) {\n  // Include contract names ending in \"System\", but not the base \"System\" contract, and not Interfaces\n  const defaultSystemNames =\n    existingContracts?.filter((name) => name.endsWith(\"System\") && name !== \"System\" && !name.match(/^I[A-Z]/)) ?? [];\n  const overriddenSystemNames = Object.keys(config.systems);\n\n  // Validate every key in systems refers to an existing system contract (and is not called \"World\")\n  if (existingContracts) {\n    for (const systemName of overriddenSystemNames) {\n      if (!existingContracts.includes(systemName) || systemName === \"World\") {\n        throw UnrecognizedSystemErrorFactory([\"systems\", systemName], systemName);\n      }\n    }\n  }\n\n  // Combine the default and overridden system names and filter out excluded systems\n  const systemNames = [...new Set([...defaultSystemNames, ...overriddenSystemNames])].filter(\n    (name) => !config.excludeSystems.includes(name)\n  );\n\n  // Resolve the config\n  const resolvedSystems: Record<string, ResolvedSystemConfig> = systemNames.reduce((acc, systemName) => {\n    return {\n      ...acc,\n      [systemName]: resolveSystemConfig(systemName, config.systems[systemName], existingContracts),\n    };\n  }, {});\n\n  return { systems: resolvedSystems };\n}\n\n/**\n * Resolves the system config by combining the default and overridden system configs,\n * @param systemName name of the system\n * @param config optional SystemConfig object, if none is provided the default config is used\n * @param existingContracts optional list of existing contract names, used to validate system names in the access list. If not provided, no validation is performed.\n * @returns ResolvedSystemConfig object\n * Default value for name is `systemName`\n * Default value for registerFunctionSelectors is true\n * Default value for openAccess is true\n * Default value for accessListAddresses is []\n * Default value for accessListSystems is []\n */\nexport function resolveSystemConfig(systemName: string, config?: SystemConfig, existingContracts?: string[]) {\n  const name = (config?.name ?? systemName).slice(0, STORE_NAME_MAX_LENGTH);\n  const registerFunctionSelectors = config?.registerFunctionSelectors ?? true;\n  const openAccess = config?.openAccess ?? true;\n  const accessListAddresses: string[] = [];\n  const accessListSystems: string[] = [];\n  const accessList = config && !config.openAccess ? config.accessList : [];\n\n  // Split the access list into addresses and system names\n  for (const accessListItem of accessList) {\n    if (accessListItem.startsWith(\"0x\")) {\n      accessListAddresses.push(accessListItem);\n    } else {\n      // Validate every system refers to an existing system contract\n      if (existingContracts && !existingContracts.includes(accessListItem)) {\n        throw UnrecognizedSystemErrorFactory([\"systems\", systemName, \"accessList\"], accessListItem);\n      }\n      accessListSystems.push(accessListItem);\n    }\n  }\n\n  return { name, registerFunctionSelectors, openAccess, accessListAddresses, accessListSystems };\n}\n"],"mappings":"AAAA,OAAS,yBAAAA,EAAuB,kCAAAC,MAAsC,qBAa/D,SAASC,EAAmBC,EAAmCC,EAA8B,CAElG,IAAMC,EACJD,GAAmB,OAAQE,GAASA,EAAK,SAAS,QAAQ,GAAKA,IAAS,UAAY,CAACA,EAAK,MAAM,SAAS,CAAC,GAAK,CAAC,EAC5GC,EAAwB,OAAO,KAAKJ,EAAO,OAAO,EAGxD,GAAIC,GACF,QAAWI,KAAcD,EACvB,GAAI,CAACH,EAAkB,SAASI,CAAU,GAAKA,IAAe,QAC5D,MAAMP,EAA+B,CAAC,UAAWO,CAAU,EAAGA,CAAU,EAkB9E,MAAO,CAAE,QAZW,CAAC,GAAG,IAAI,IAAI,CAAC,GAAGH,EAAoB,GAAGE,CAAqB,CAAC,CAAC,EAAE,OACjFD,GAAS,CAACH,EAAO,eAAe,SAASG,CAAI,CAChD,EAG0E,OAAO,CAACG,EAAKD,KAC9E,CACL,GAAGC,EACH,CAACD,CAAU,EAAGE,EAAoBF,EAAYL,EAAO,QAAQK,CAAU,EAAGJ,CAAiB,CAC7F,GACC,CAAC,CAAC,CAE6B,CACpC,CAcO,SAASM,EAAoBF,EAAoBL,EAAuBC,EAA8B,CAC3G,IAAME,GAAQH,GAAQ,MAAQK,GAAY,MAAM,EAAGR,CAAqB,EAClEW,EAA4BR,GAAQ,2BAA6B,GACjES,EAAaT,GAAQ,YAAc,GACnCU,EAAgC,CAAC,EACjCC,EAA8B,CAAC,EAC/BC,EAAaZ,GAAU,CAACA,EAAO,WAAaA,EAAO,WAAa,CAAC,EAGvE,QAAWa,KAAkBD,EAC3B,GAAIC,EAAe,WAAW,IAAI,EAChCH,EAAoB,KAAKG,CAAc,MAClC,CAEL,GAAIZ,GAAqB,CAACA,EAAkB,SAASY,CAAc,EACjE,MAAMf,EAA+B,CAAC,UAAWO,EAAY,YAAY,EAAGQ,CAAc,EAE5FF,EAAkB,KAAKE,CAAc,EAIzC,MAAO,CAAE,KAAAV,EAAM,0BAAAK,EAA2B,WAAAC,EAAY,oBAAAC,EAAqB,kBAAAC,CAAkB,CAC/F","names":["STORE_NAME_MAX_LENGTH","UnrecognizedSystemErrorFactory","resolveWorldConfig","config","existingContracts","defaultSystemNames","name","overriddenSystemNames","systemName","acc","resolveSystemConfig","registerFunctionSelectors","openAccess","accessListAddresses","accessListSystems","accessList","accessListItem"]}

package/dist/ts/index.js

@@ -1,2 +1,2 @@
-import{a as e,b as o,c as r,d as t}from"../chunk-UYSOB7U2.js";import{a as d,b as l}from"../chunk-IPKL3OQG.js";var n="event WorldDeployed(address indexed newContract)",p="event HelloWorld(bytes32 indexed worldVersion)";export{e as SYSTEM_DEFAULTS,o as WORLD_DEFAULTS,p as helloWorldEvent,l as resolveSystemConfig,d as resolveWorldConfig,n as worldDeployedEvent,t as zPluginWorldConfig,r as zWorldConfig};
+import{a as e,b as o,c as r,d as t}from"../chunk-UYSOB7U2.js";import{a as d,b as l}from"../chunk-BZ6EK2LH.js";var n="event WorldDeployed(address indexed newContract)",p="event HelloWorld(bytes32 indexed worldVersion)";export{e as SYSTEM_DEFAULTS,o as WORLD_DEFAULTS,p as helloWorldEvent,l as resolveSystemConfig,d as resolveWorldConfig,n as worldDeployedEvent,t as zPluginWorldConfig,r as zWorldConfig};
 //# sourceMappingURL=index.js.map

package/dist/ts/node/index.js

@@ -1,4 +1,4 @@
-import{a as u}from"../../chunk-IPKL3OQG.js";import{renderArguments as c,renderList as y,renderedSolidityHeader as v,renderImports as D}from"@latticexyz/common/codegen";function h(e){let{imports:r,name:m,functionPrefix:s,functions:o,errors:i}=e;return`
+import{a as u}from"../../chunk-BZ6EK2LH.js";import{renderArguments as c,renderList as y,renderedSolidityHeader as v,renderImports as D}from"@latticexyz/common/codegen";function h(e){let{imports:r,name:m,functionPrefix:s,functions:o,errors:i}=e;return`
     ${v}
 
     ${D(r)}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@latticexyz/world",
-  "version": "2.0.0-main-e241c056",
+  "version": "2.0.0-main-29c3f508",
   "description": "World framework",
   "repository": {
     "type": "git",
@@ -32,10 +32,10 @@
   "dependencies": {
     "abitype": "0.9.8",
     "zod": "^3.21.4",
-    "@latticexyz/common": "2.0.0-main-e241c056",
-    "@latticexyz/config": "2.0.0-main-e241c056",
-    "@latticexyz/schema-type": "2.0.0-main-e241c056",
-    "@latticexyz/store": "2.0.0-main-e241c056"
+    "@latticexyz/common": "2.0.0-main-29c3f508",
+    "@latticexyz/config": "2.0.0-main-29c3f508",
+    "@latticexyz/schema-type": "2.0.0-main-29c3f508",
+    "@latticexyz/store": "2.0.0-main-29c3f508"
   },
   "devDependencies": {
     "@types/ejs": "^3.1.1",
@@ -50,8 +50,8 @@
     "tsup": "^6.7.0",
     "tsx": "^3.12.6",
     "vitest": "0.31.4",
-    "@latticexyz/abi-ts": "2.0.0-main-e241c056",
-    "@latticexyz/gas-report": "2.0.0-main-e241c056"
+    "@latticexyz/abi-ts": "2.0.0-main-29c3f508",
+    "@latticexyz/gas-report": "2.0.0-main-29c3f508"
   },
   "gitHead": "914a1e0ae4a573d685841ca2ea921435057deb8f",
   "scripts": {
@@ -67,7 +67,7 @@
     "dev": "tsup --watch",
     "gas-report": "gas-report --save gas-report.json",
     "lint": "solhint --config ./.solhint.json 'src/**/*.sol'",
-    "test": "tsc --noEmit && vitest --run && forge test",
+    "test": "tsc --noEmit && vitest --run --passWithNoTests && forge test",
     "test:ci": "pnpm run test"
   }
 }

package/ts/config/resolveWorldConfig.ts

@@ -1,5 +1,4 @@
-import { getDuplicates, STORE_NAME_MAX_LENGTH, UnrecognizedSystemErrorFactory } from "@latticexyz/config";
-import { MUDError } from "@latticexyz/common/errors";
+import { STORE_NAME_MAX_LENGTH, UnrecognizedSystemErrorFactory } from "@latticexyz/config";
 import { StoreConfig } from "@latticexyz/store";
 import { SystemConfig, WorldConfig } from "./types";
 
@@ -40,14 +39,6 @@ export function resolveWorldConfig(config: StoreConfig & WorldConfig, existingCo
     };
   }, {});
 
-  // Table and system names must be unique (because they're both used for world selectors)
-  const tableNames = Object.values(config.tables).map(({ name }) => name);
-  const configuredSystemNames = Object.values(resolvedSystems).map(({ name }) => name);
-  const duplicateNames = getDuplicates([...tableNames, ...configuredSystemNames]);
-  if (duplicateNames.length > 0) {
-    throw new MUDError(`Table and system names must be unique: ${duplicateNames.join(", ")}`);
-  }
-
   return { systems: resolvedSystems };
 }
 

package/dist/chunk-IPKL3OQG.js

@@ -1,2 +0,0 @@
-import{getDuplicates as d,STORE_NAME_MAX_LENGTH as f,UnrecognizedSystemErrorFactory as u}from"@latticexyz/config";import{MUDError as p}from"@latticexyz/common/errors";function v(t,s){let o=s?.filter(e=>e.endsWith("System")&&e!=="System"&&!e.match(/^I[A-Z]/))??[],r=Object.keys(t.systems);if(s){for(let e of r)if(!s.includes(e)||e==="World")throw u(["systems",e],e)}let n=[...new Set([...o,...r])].filter(e=>!t.excludeSystems.includes(e)).reduce((e,l)=>({...e,[l]:a(l,t.systems[l],s)}),{}),c=Object.values(t.tables).map(({name:e})=>e),m=Object.values(n).map(({name:e})=>e),i=d([...c,...m]);if(i.length>0)throw new p(`Table and system names must be unique: ${i.join(", ")}`);return{systems:n}}function a(t,s,o){let r=(s?.name??t).slice(0,f),y=s?.registerFunctionSelectors??!0,n=s?.openAccess??!0,c=[],m=[],i=s&&!s.openAccess?s.accessList:[];for(let e of i)if(e.startsWith("0x"))c.push(e);else{if(o&&!o.includes(e))throw u(["systems",t,"accessList"],e);m.push(e)}return{name:r,registerFunctionSelectors:y,openAccess:n,accessListAddresses:c,accessListSystems:m}}export{v as a,a as b};
-//# sourceMappingURL=chunk-IPKL3OQG.js.map

package/dist/chunk-IPKL3OQG.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../ts/config/resolveWorldConfig.ts"],"sourcesContent":["import { getDuplicates, STORE_NAME_MAX_LENGTH, UnrecognizedSystemErrorFactory } from \"@latticexyz/config\";\nimport { MUDError } from \"@latticexyz/common/errors\";\nimport { StoreConfig } from \"@latticexyz/store\";\nimport { SystemConfig, WorldConfig } from \"./types\";\n\nexport type ResolvedSystemConfig = ReturnType<typeof resolveSystemConfig>;\n\nexport type ResolvedWorldConfig = ReturnType<typeof resolveWorldConfig>;\n\n/**\n * Resolves the world config by combining the default and overridden system configs,\n * filtering out excluded systems, validate system names refer to existing contracts, and\n * splitting the access list into addresses and system names.\n */\nexport function resolveWorldConfig(config: StoreConfig & WorldConfig, existingContracts?: string[]) {\n  // Include contract names ending in \"System\", but not the base \"System\" contract, and not Interfaces\n  const defaultSystemNames =\n    existingContracts?.filter((name) => name.endsWith(\"System\") && name !== \"System\" && !name.match(/^I[A-Z]/)) ?? [];\n  const overriddenSystemNames = Object.keys(config.systems);\n\n  // Validate every key in systems refers to an existing system contract (and is not called \"World\")\n  if (existingContracts) {\n    for (const systemName of overriddenSystemNames) {\n      if (!existingContracts.includes(systemName) || systemName === \"World\") {\n        throw UnrecognizedSystemErrorFactory([\"systems\", systemName], systemName);\n      }\n    }\n  }\n\n  // Combine the default and overridden system names and filter out excluded systems\n  const systemNames = [...new Set([...defaultSystemNames, ...overriddenSystemNames])].filter(\n    (name) => !config.excludeSystems.includes(name)\n  );\n\n  // Resolve the config\n  const resolvedSystems: Record<string, ResolvedSystemConfig> = systemNames.reduce((acc, systemName) => {\n    return {\n      ...acc,\n      [systemName]: resolveSystemConfig(systemName, config.systems[systemName], existingContracts),\n    };\n  }, {});\n\n  // Table and system names must be unique (because they're both used for world selectors)\n  const tableNames = Object.values(config.tables).map(({ name }) => name);\n  const configuredSystemNames = Object.values(resolvedSystems).map(({ name }) => name);\n  const duplicateNames = getDuplicates([...tableNames, ...configuredSystemNames]);\n  if (duplicateNames.length > 0) {\n    throw new MUDError(`Table and system names must be unique: ${duplicateNames.join(\", \")}`);\n  }\n\n  return { systems: resolvedSystems };\n}\n\n/**\n * Resolves the system config by combining the default and overridden system configs,\n * @param systemName name of the system\n * @param config optional SystemConfig object, if none is provided the default config is used\n * @param existingContracts optional list of existing contract names, used to validate system names in the access list. If not provided, no validation is performed.\n * @returns ResolvedSystemConfig object\n * Default value for name is `systemName`\n * Default value for registerFunctionSelectors is true\n * Default value for openAccess is true\n * Default value for accessListAddresses is []\n * Default value for accessListSystems is []\n */\nexport function resolveSystemConfig(systemName: string, config?: SystemConfig, existingContracts?: string[]) {\n  const name = (config?.name ?? systemName).slice(0, STORE_NAME_MAX_LENGTH);\n  const registerFunctionSelectors = config?.registerFunctionSelectors ?? true;\n  const openAccess = config?.openAccess ?? true;\n  const accessListAddresses: string[] = [];\n  const accessListSystems: string[] = [];\n  const accessList = config && !config.openAccess ? config.accessList : [];\n\n  // Split the access list into addresses and system names\n  for (const accessListItem of accessList) {\n    if (accessListItem.startsWith(\"0x\")) {\n      accessListAddresses.push(accessListItem);\n    } else {\n      // Validate every system refers to an existing system contract\n      if (existingContracts && !existingContracts.includes(accessListItem)) {\n        throw UnrecognizedSystemErrorFactory([\"systems\", systemName, \"accessList\"], accessListItem);\n      }\n      accessListSystems.push(accessListItem);\n    }\n  }\n\n  return { name, registerFunctionSelectors, openAccess, accessListAddresses, accessListSystems };\n}\n"],"mappings":"AAAA,OAAS,iBAAAA,EAAe,yBAAAC,EAAuB,kCAAAC,MAAsC,qBACrF,OAAS,YAAAC,MAAgB,4BAalB,SAASC,EAAmBC,EAAmCC,EAA8B,CAElG,IAAMC,EACJD,GAAmB,OAAQE,GAASA,EAAK,SAAS,QAAQ,GAAKA,IAAS,UAAY,CAACA,EAAK,MAAM,SAAS,CAAC,GAAK,CAAC,EAC5GC,EAAwB,OAAO,KAAKJ,EAAO,OAAO,EAGxD,GAAIC,GACF,QAAWI,KAAcD,EACvB,GAAI,CAACH,EAAkB,SAASI,CAAU,GAAKA,IAAe,QAC5D,MAAMR,EAA+B,CAAC,UAAWQ,CAAU,EAAGA,CAAU,EAW9E,IAAMC,EALc,CAAC,GAAG,IAAI,IAAI,CAAC,GAAGJ,EAAoB,GAAGE,CAAqB,CAAC,CAAC,EAAE,OACjFD,GAAS,CAACH,EAAO,eAAe,SAASG,CAAI,CAChD,EAG0E,OAAO,CAACI,EAAKF,KAC9E,CACL,GAAGE,EACH,CAACF,CAAU,EAAGG,EAAoBH,EAAYL,EAAO,QAAQK,CAAU,EAAGJ,CAAiB,CAC7F,GACC,CAAC,CAAC,EAGCQ,EAAa,OAAO,OAAOT,EAAO,MAAM,EAAE,IAAI,CAAC,CAAE,KAAAG,CAAK,IAAMA,CAAI,EAChEO,EAAwB,OAAO,OAAOJ,CAAe,EAAE,IAAI,CAAC,CAAE,KAAAH,CAAK,IAAMA,CAAI,EAC7EQ,EAAiBhB,EAAc,CAAC,GAAGc,EAAY,GAAGC,CAAqB,CAAC,EAC9E,GAAIC,EAAe,OAAS,EAC1B,MAAM,IAAIb,EAAS,0CAA0Ca,EAAe,KAAK,IAAI,GAAG,EAG1F,MAAO,CAAE,QAASL,CAAgB,CACpC,CAcO,SAASE,EAAoBH,EAAoBL,EAAuBC,EAA8B,CAC3G,IAAME,GAAQH,GAAQ,MAAQK,GAAY,MAAM,EAAGT,CAAqB,EAClEgB,EAA4BZ,GAAQ,2BAA6B,GACjEa,EAAab,GAAQ,YAAc,GACnCc,EAAgC,CAAC,EACjCC,EAA8B,CAAC,EAC/BC,EAAahB,GAAU,CAACA,EAAO,WAAaA,EAAO,WAAa,CAAC,EAGvE,QAAWiB,KAAkBD,EAC3B,GAAIC,EAAe,WAAW,IAAI,EAChCH,EAAoB,KAAKG,CAAc,MAClC,CAEL,GAAIhB,GAAqB,CAACA,EAAkB,SAASgB,CAAc,EACjE,MAAMpB,EAA+B,CAAC,UAAWQ,EAAY,YAAY,EAAGY,CAAc,EAE5FF,EAAkB,KAAKE,CAAc,EAIzC,MAAO,CAAE,KAAAd,EAAM,0BAAAS,EAA2B,WAAAC,EAAY,oBAAAC,EAAqB,kBAAAC,CAAkB,CAC/F","names":["getDuplicates","STORE_NAME_MAX_LENGTH","UnrecognizedSystemErrorFactory","MUDError","resolveWorldConfig","config","existingContracts","defaultSystemNames","name","overriddenSystemNames","systemName","resolvedSystems","acc","resolveSystemConfig","tableNames","configuredSystemNames","duplicateNames","registerFunctionSelectors","openAccess","accessListAddresses","accessListSystems","accessList","accessListItem"]}

package/ts/register/index.test.ts

@@ -1,24 +0,0 @@
-import { expect, test } from "vitest";
-import { mudConfig } from ".";
-import { resolveWorldConfig } from "../config/resolveWorldConfig";
-
-test("resolveWorldConfig requires unique table and system names", () => {
-  expect(() =>
-    resolveWorldConfig(
-      mudConfig({
-        tables: {
-          Selector: {
-            valueSchema: "uint256",
-          },
-        },
-        systems: {
-          Selector: {
-            openAccess: false,
-            accessList: [],
-          },
-        },
-      }),
-      ["Selector"]
-    )
-  ).toThrowError("Table and system names must be unique: Selector");
-});