Version Packages (next)

latticexyz · Sep 14, 2023 · cecbdd6 · cecbdd6
1 parent 4e0200f
commit cecbdd6
Show file tree

Hide file tree

Showing 59 changed files with 474 additions and 34 deletions.
diff --git a/.changeset/pre.json b/.changeset/pre.json
@@ -57,6 +57,7 @@
     "fuzzy-cars-stare",
     "giant-masks-carry",
     "great-cooks-dream",
+    "grumpy-files-heal",
     "grumpy-geckos-raise",
     "itchy-kids-relax",
     "itchy-shoes-appear",
@@ -86,6 +87,7 @@
     "pink-tips-give",
     "pretty-hotels-drop",
     "quick-numbers-flash",
+    "quiet-dancers-prove",
     "quiet-squids-share",
     "rare-planes-draw",
     "rare-trainers-fry",
@@ -107,8 +109,10 @@
     "strange-candles-shout",
     "strange-ducks-float",
     "strong-geckos-shake",
+    "strong-months-push",
     "tame-lemons-play",
     "thin-buses-reply",
+    "tricky-beds-kiss",
     "tricky-carrots-talk",
     "tricky-comics-remain",
     "tricky-frogs-beam",

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,71 @@
+## Version 2.0.0-next.9
+
+### Major changes
+
+**[feat: replace Schema with FieldLayout for contract internals (#1336)](https://github.com/latticexyz/mud/commit/de151fec07b63a6022483c1ad133c556dd44992e)** (@latticexyz/cli, @latticexyz/protocol-parser, @latticexyz/store, @latticexyz/world)
+
+- Add `FieldLayout`, which is a `bytes32` user-type similar to `Schema`.
+
+  Both `FieldLayout` and `Schema` have the same kind of data in the first 4 bytes.
+
+  - 2 bytes for total length of all static fields
+  - 1 byte for number of static size fields
+  - 1 byte for number of dynamic size fields
+
+  But whereas `Schema` has `SchemaType` enum in each of the other 28 bytes, `FieldLayout` has static byte lengths in each of the other 28 bytes.
+
+- Replace `Schema valueSchema` with `FieldLayout fieldLayout` in Store and World contracts.
+
+  `FieldLayout` is more gas-efficient because it already has lengths, and `Schema` has types which need to be converted to lengths.
+
+- Add `getFieldLayout` to `IStore` interface.
+
+  There is no `FieldLayout` for keys, only for values, because key byte lengths aren't usually relevant on-chain. You can still use `getKeySchema` if you need key types.
+
+- Add `fieldLayoutToHex` utility to `protocol-parser` package.
+
+- Add `constants.sol` for constants shared between `FieldLayout`, `Schema` and `PackedCounter`.
+
+**[feat(world,store): add initialize method, initialize core tables in core module (#1472)](https://github.com/latticexyz/mud/commit/c049c23f48b93ac7881fb1a5a8417831611d5cbf)** (@latticexyz/store)
+
+- `StoreCore`'s `initialize` function is split into `initialize` (to set the `StoreSwitch`'s `storeAddress`) and `registerCoreTables` (to register the `Tables` and `StoreHooks` tables).
+  The purpose of this is to give consumers more granular control over the setup flow.
+
+- The `StoreRead` contract no longer calls `StoreCore.initialize` in its constructor.
+  `StoreCore` consumers are expected to call `StoreCore.initialize` and `StoreCore.registerCoreTable` in their own setup logic.
+
+### Minor changes
+
+**[feat(world,store): add initialize method, initialize core tables in core module (#1472)](https://github.com/latticexyz/mud/commit/c049c23f48b93ac7881fb1a5a8417831611d5cbf)** (@latticexyz/cli, @latticexyz/world)
+
+- The `World` contract now has an `initialize` function, which can be called once by the creator of the World to install the core module.
+  This change allows the registration of all core tables to happen in the `CoreModule`, so no table metadata has to be included in the `World`'s bytecode.
+
+  ```solidity
+  interface IBaseWorld {
+    function initialize(IModule coreModule) public;
+  }
+  ```
+
+- The `World` contract now stores the original creator of the `World` in an immutable state variable.
+  It is used internally to only allow the original creator to initialize the `World` in a separate transaction.
+
+  ```solidity
+  interface IBaseWorld {
+    function creator() external view returns (address);
+  }
+  ```
+
+- The deploy script is updated to use the `World`'s `initialize` function to install the `CoreModule` instead of `registerRootModule` as before.
+
+### Patch changes
+
+**[fix(world): register Delegations table in CoreModule (#1452)](https://github.com/latticexyz/mud/commit/f1cd43bf9264d5a23a3edf2a1ea4212361a72203)** (@latticexyz/world)
+
+Register `Delegations` table in the `CoreModule`
+
+---
+
 ## Version 2.0.0-next.8
 
 ### Major changes

diff --git a/docs/pages/changelog.mdx b/docs/pages/changelog.mdx
@@ -1,3 +1,71 @@
+## Version 2.0.0-next.9
+
+### Major changes
+
+**[feat: replace Schema with FieldLayout for contract internals (#1336)](https://github.com/latticexyz/mud/commit/de151fec07b63a6022483c1ad133c556dd44992e)** (@latticexyz/cli, @latticexyz/protocol-parser, @latticexyz/store, @latticexyz/world)
+
+- Add `FieldLayout`, which is a `bytes32` user-type similar to `Schema`.
+
+  Both `FieldLayout` and `Schema` have the same kind of data in the first 4 bytes.
+
+  - 2 bytes for total length of all static fields
+  - 1 byte for number of static size fields
+  - 1 byte for number of dynamic size fields
+
+  But whereas `Schema` has `SchemaType` enum in each of the other 28 bytes, `FieldLayout` has static byte lengths in each of the other 28 bytes.
+
+- Replace `Schema valueSchema` with `FieldLayout fieldLayout` in Store and World contracts.
+
+  `FieldLayout` is more gas-efficient because it already has lengths, and `Schema` has types which need to be converted to lengths.
+
+- Add `getFieldLayout` to `IStore` interface.
+
+  There is no `FieldLayout` for keys, only for values, because key byte lengths aren't usually relevant on-chain. You can still use `getKeySchema` if you need key types.
+
+- Add `fieldLayoutToHex` utility to `protocol-parser` package.
+
+- Add `constants.sol` for constants shared between `FieldLayout`, `Schema` and `PackedCounter`.
+
+**[feat(world,store): add initialize method, initialize core tables in core module (#1472)](https://github.com/latticexyz/mud/commit/c049c23f48b93ac7881fb1a5a8417831611d5cbf)** (@latticexyz/store)
+
+- `StoreCore`'s `initialize` function is split into `initialize` (to set the `StoreSwitch`'s `storeAddress`) and `registerCoreTables` (to register the `Tables` and `StoreHooks` tables).
+  The purpose of this is to give consumers more granular control over the setup flow.
+
+- The `StoreRead` contract no longer calls `StoreCore.initialize` in its constructor.
+  `StoreCore` consumers are expected to call `StoreCore.initialize` and `StoreCore.registerCoreTable` in their own setup logic.
+
+### Minor changes
+
+**[feat(world,store): add initialize method, initialize core tables in core module (#1472)](https://github.com/latticexyz/mud/commit/c049c23f48b93ac7881fb1a5a8417831611d5cbf)** (@latticexyz/cli, @latticexyz/world)
+
+- The `World` contract now has an `initialize` function, which can be called once by the creator of the World to install the core module.
+  This change allows the registration of all core tables to happen in the `CoreModule`, so no table metadata has to be included in the `World`'s bytecode.
+
+  ```solidity
+  interface IBaseWorld {
+    function initialize(IModule coreModule) public;
+  }
+  ```
+
+- The `World` contract now stores the original creator of the `World` in an immutable state variable.
+  It is used internally to only allow the original creator to initialize the `World` in a separate transaction.
+
+  ```solidity
+  interface IBaseWorld {
+    function creator() external view returns (address);
+  }
+  ```
+
+- The deploy script is updated to use the `World`'s `initialize` function to install the `CoreModule` instead of `registerRootModule` as before.
+
+### Patch changes
+
+**[fix(world): register Delegations table in CoreModule (#1452)](https://github.com/latticexyz/mud/commit/f1cd43bf9264d5a23a3edf2a1ea4212361a72203)** (@latticexyz/world)
+
+Register `Delegations` table in the `CoreModule`
+
+---
+
 ## Version 2.0.0-next.8
 
 ### Major changes

diff --git a/packages/abi-ts/CHANGELOG.md b/packages/abi-ts/CHANGELOG.md
@@ -1,5 +1,7 @@
 # @latticexyz/abi-ts
 
+## 2.0.0-next.9
+
 ## 2.0.0-next.8
 
 ## 2.0.0-next.7

diff --git a/packages/abi-ts/package.json b/packages/abi-ts/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@latticexyz/abi-ts",
-  "version": "2.0.0-next.8",
+  "version": "2.0.0-next.9",
   "description": "Create TypeScript type declaration files (`.d.ts`) for your ABI JSON files.",
   "repository": {
     "type": "git",

diff --git a/packages/block-logs-stream/CHANGELOG.md b/packages/block-logs-stream/CHANGELOG.md
@@ -1,5 +1,12 @@
 # @latticexyz/block-logs-stream
 
+## 2.0.0-next.9
+
+### Patch Changes
+
+- Updated dependencies []:
+  - @latticexyz/common@2.0.0-next.9
+
 ## 2.0.0-next.8
 
 ### Patch Changes

diff --git a/packages/block-logs-stream/package.json b/packages/block-logs-stream/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@latticexyz/block-logs-stream",
-  "version": "2.0.0-next.8",
+  "version": "2.0.0-next.9",
   "description": "Create a stream of EVM block logs for events",
   "repository": {
     "type": "git",

diff --git a/packages/cli/CHANGELOG.md b/packages/cli/CHANGELOG.md
@@ -1,5 +1,65 @@
 # Change Log
 
+## 2.0.0-next.9
+
+### Major Changes
+
+- [#1336](https://github.com/latticexyz/mud/pull/1336) [`de151fec`](https://github.com/latticexyz/mud/commit/de151fec07b63a6022483c1ad133c556dd44992e) Thanks [@dk1a](https://github.com/dk1a)! - - Add `FieldLayout`, which is a `bytes32` user-type similar to `Schema`.
+
+  Both `FieldLayout` and `Schema` have the same kind of data in the first 4 bytes.
+
+  - 2 bytes for total length of all static fields
+  - 1 byte for number of static size fields
+  - 1 byte for number of dynamic size fields
+
+  But whereas `Schema` has `SchemaType` enum in each of the other 28 bytes, `FieldLayout` has static byte lengths in each of the other 28 bytes.
+
+  - Replace `Schema valueSchema` with `FieldLayout fieldLayout` in Store and World contracts.
+
+    `FieldLayout` is more gas-efficient because it already has lengths, and `Schema` has types which need to be converted to lengths.
+
+  - Add `getFieldLayout` to `IStore` interface.
+
+    There is no `FieldLayout` for keys, only for values, because key byte lengths aren't usually relevant on-chain. You can still use `getKeySchema` if you need key types.
+
+  - Add `fieldLayoutToHex` utility to `protocol-parser` package.
+
+  - Add `constants.sol` for constants shared between `FieldLayout`, `Schema` and `PackedCounter`.
+
+### Patch Changes
+
+- [#1472](https://github.com/latticexyz/mud/pull/1472) [`c049c23f`](https://github.com/latticexyz/mud/commit/c049c23f48b93ac7881fb1a5a8417831611d5cbf) Thanks [@alvrs](https://github.com/alvrs)! - - The `World` contract now has an `initialize` function, which can be called once by the creator of the World to install the core module.
+  This change allows the registration of all core tables to happen in the `CoreModule`, so no table metadata has to be included in the `World`'s bytecode.
+
+  ```solidity
+  interface IBaseWorld {
+    function initialize(IModule coreModule) public;
+  }
+  ```
+
+  - The `World` contract now stores the original creator of the `World` in an immutable state variable.
+    It is used internally to only allow the original creator to initialize the `World` in a separate transaction.
+
+    ```solidity
+    interface IBaseWorld {
+      function creator() external view returns (address);
+    }
+    ```
+
+  - The deploy script is updated to use the `World`'s `initialize` function to install the `CoreModule` instead of `registerRootModule` as before.
+
+- Updated dependencies [[`de151fec`](https://github.com/latticexyz/mud/commit/de151fec07b63a6022483c1ad133c556dd44992e), [`f1cd43bf`](https://github.com/latticexyz/mud/commit/f1cd43bf9264d5a23a3edf2a1ea4212361a72203), [`c049c23f`](https://github.com/latticexyz/mud/commit/c049c23f48b93ac7881fb1a5a8417831611d5cbf), [`c049c23f`](https://github.com/latticexyz/mud/commit/c049c23f48b93ac7881fb1a5a8417831611d5cbf)]:
+  - @latticexyz/[email protected]
+  - @latticexyz/[email protected]
+  - @latticexyz/[email protected]
+  - @latticexyz/[email protected]
+  - @latticexyz/[email protected]
+  - @latticexyz/[email protected]
+  - @latticexyz/[email protected]
+  - @latticexyz/[email protected]
+  - @latticexyz/[email protected]
+  - @latticexyz/[email protected]
+
 ## 2.0.0-next.8
 
 ### Patch Changes

diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@latticexyz/cli",
-  "version": "2.0.0-next.8",
+  "version": "2.0.0-next.9",
   "description": "Command line interface for mud",
   "repository": {
     "type": "git",

diff --git a/packages/common/CHANGELOG.md b/packages/common/CHANGELOG.md
@@ -1,5 +1,12 @@
 # Change Log
 
+## 2.0.0-next.9
+
+### Patch Changes
+
+- Updated dependencies []:
+  - @latticexyz/schema-type@2.0.0-next.9
+
 ## 2.0.0-next.8
 
 ### Patch Changes

diff --git a/packages/common/package.json b/packages/common/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@latticexyz/common",
-  "version": "2.0.0-next.8",
+  "version": "2.0.0-next.9",
   "description": "Common low level logic shared between packages",
   "repository": {
     "type": "git",

diff --git a/packages/config/CHANGELOG.md b/packages/config/CHANGELOG.md
@@ -1,5 +1,13 @@
 # Change Log
 
+## 2.0.0-next.9
+
+### Patch Changes
+
+- Updated dependencies []:
+  - @latticexyz/common@2.0.0-next.9
+  - @latticexyz/schema-type@2.0.0-next.9
+
 ## 2.0.0-next.8
 
 ### Patch Changes

diff --git a/packages/config/package.json b/packages/config/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@latticexyz/config",
-  "version": "2.0.0-next.8",
+  "version": "2.0.0-next.9",
   "description": "Config for Store and World",
   "repository": {
     "type": "git",

diff --git a/packages/create-mud/CHANGELOG.md b/packages/create-mud/CHANGELOG.md
@@ -1,5 +1,7 @@
 # Change Log
 
+## 2.0.0-next.9
+
 ## 2.0.0-next.8
 
 ## 2.0.0-next.7

diff --git a/packages/create-mud/package.json b/packages/create-mud/package.json
@@ -1,6 +1,6 @@
 {
   "name": "create-mud",
-  "version": "2.0.0-next.8",
+  "version": "2.0.0-next.9",
   "description": "Create a new MUD project",
   "license": "MIT",
   "author": "Lattice <[email protected]>",

diff --git a/packages/dev-tools/CHANGELOG.md b/packages/dev-tools/CHANGELOG.md
@@ -1,5 +1,18 @@
 # @latticexyz/dev-tools
 
+## 2.0.0-next.9
+
+### Patch Changes
+
+- Updated dependencies [[`de151fec`](https://github.com/latticexyz/mud/commit/de151fec07b63a6022483c1ad133c556dd44992e), [`f1cd43bf`](https://github.com/latticexyz/mud/commit/f1cd43bf9264d5a23a3edf2a1ea4212361a72203), [`c049c23f`](https://github.com/latticexyz/mud/commit/c049c23f48b93ac7881fb1a5a8417831611d5cbf), [`c049c23f`](https://github.com/latticexyz/mud/commit/c049c23f48b93ac7881fb1a5a8417831611d5cbf)]:
+  - @latticexyz/store@2.0.0-next.9
+  - @latticexyz/world@2.0.0-next.9
+  - @latticexyz/store-sync@2.0.0-next.9
+  - @latticexyz/react@2.0.0-next.9
+  - @latticexyz/common@2.0.0-next.9
+  - @latticexyz/recs@2.0.0-next.9
+  - @latticexyz/utils@2.0.0-next.9
+
 ## 2.0.0-next.8
 
 ### Patch Changes

diff --git a/packages/dev-tools/package.json b/packages/dev-tools/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@latticexyz/dev-tools",
-  "version": "2.0.0-next.8",
+  "version": "2.0.0-next.9",
   "description": "MUD developer tools",
   "repository": {
     "type": "git",
@@ -51,12 +51,12 @@
     "vitest": "0.31.4"
   },
   "peerDependencies": {
-    "@latticexyz/common": "2.0.0-next.8",
-    "@latticexyz/recs": "2.0.0-next.8",
-    "@latticexyz/store": "2.0.0-next.8",
-    "@latticexyz/store-sync": "2.0.0-next.8",
-    "@latticexyz/utils": "2.0.0-next.8",
-    "@latticexyz/world": "2.0.0-next.8"
+    "@latticexyz/common": "2.0.0-next.9",
+    "@latticexyz/recs": "2.0.0-next.9",
+    "@latticexyz/store": "2.0.0-next.9",
+    "@latticexyz/store-sync": "2.0.0-next.9",
+    "@latticexyz/utils": "2.0.0-next.9",
+    "@latticexyz/world": "2.0.0-next.9"
   },
   "publishConfig": {
     "access": "public"

diff --git a/packages/ecs-browser/CHANGELOG.md b/packages/ecs-browser/CHANGELOG.md
@@ -1,5 +1,7 @@
 # @latticexyz/ecs-browser
 
+## 2.0.0-next.9
+
 ## 2.0.0-next.8
 
 ## 2.0.0-next.7