Version Packages (next)

latticexyz · Aug 18, 2023 · 3b29073 · 3b29073
1 parent 5135423
commit 3b29073
Show file tree

Hide file tree

Showing 56 changed files with 674 additions and 33 deletions.
diff --git a/.changeset/pre.json b/.changeset/pre.json
@@ -37,32 +37,39 @@
     "dirty-items-retire",
     "eighty-tigers-argue",
     "fast-ears-hug",
+    "few-mirrors-reflect",
     "fifty-squids-eat",
     "fifty-suits-shout",
     "fluffy-moles-march",
     "four-coats-pull",
     "giant-masks-carry",
     "great-cooks-dream",
+    "grumpy-geckos-raise",
     "itchy-kids-relax",
     "itchy-shoes-appear",
     "large-hats-walk",
     "large-sloths-camp",
+    "late-geese-guess",
+    "late-spies-cover",
     "lazy-ladybugs-return",
     "many-phones-study",
     "mean-pans-study",
     "metal-cats-double",
     "modern-bikes-build",
+    "modern-hornets-jam",
     "nasty-waves-divide",
     "nice-moose-love",
     "nice-pandas-knock",
     "olive-parrots-move",
     "perfect-mangos-cry",
+    "pink-fans-nail",
     "pink-horses-deny",
     "pretty-hotels-drop",
     "quick-numbers-flash",
     "rare-planes-draw",
     "red-turkeys-develop",
     "selfish-cycles-retire",
+    "seven-flies-chew",
     "sharp-worms-kneel",
     "smooth-elephants-wave",
     "smooth-pots-nail",
@@ -73,6 +80,7 @@
     "stale-cooks-reflect",
     "strange-candles-shout",
     "strange-ducks-float",
+    "strong-geckos-shake",
     "tame-lemons-play",
     "thin-buses-reply",
     "tricky-frogs-beam",
@@ -81,6 +89,7 @@
     "tricky-oranges-pump",
     "twenty-birds-scream",
     "weak-mails-cross",
+    "wild-gorillas-care",
     "witty-jokes-serve"
   ]
 }
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,121 @@
+# Version 2.0.0-next.3
+
+## Major changes
+
+**[feat(world, store): stop loading schema from storage, require schema as an argument (#1174)](https://github.com/latticexyz/mud/commit/952cd534447d08e6231ab147ed1cc24fb49bbb57)** (@latticexyz/cli, @latticexyz/store, @latticexyz/world, create-mud)
+
+All `Store` methods now require the table's value schema to be passed in as an argument instead of loading it from storage.
+This decreases gas cost and removes circular dependencies of the Schema table (where it was not possible to write to the Schema table before the Schema table was registered).
+
+```diff
+  function setRecord(
+    bytes32 table,
+    bytes32[] calldata key,
+    bytes calldata data,
++   Schema valueSchema
+  ) external;
+```
+
+The same diff applies to `getRecord`, `getField`, `setField`, `pushToField`, `popFromField`, `updateInField`, and `deleteRecord`.
+
+This change only requires changes in downstream projects if the `Store` methods were accessed directly. In most cases it is fully abstracted in the generated table libraries,
+so downstream projects only need to regenerate their table libraries after updating MUD.
+
+**[refactor(world): combine name and namespace to resource selector in World methods (#1208)](https://github.com/latticexyz/mud/commit/c32a9269a30c1898932ebbf7e3b60e25d1bd884c)** (@latticexyz/cli, @latticexyz/world)
+
+- All `World` function selectors that previously had `bytes16 namespace, bytes16 name` arguments now use `bytes32 resourceSelector` instead.
+  This includes `setRecord`, `setField`, `pushToField`, `popFromField`, `updateInField`, `deleteRecord`, `call`, `grantAccess`, `revokeAccess`, `registerTable`,
+  `registerStoreHook`, `registerSystemHook`, `registerFunctionSelector`, `registerSystem` and `registerRootFunctionSelector`.
+  This change aligns the `World` function selectors with the `Store` function selectors, reduces clutter, reduces gas cost and reduces the `World`'s contract size.
+
+- The `World`'s `registerHook` function is removed. Use `registerStoreHook` or `registerSystemHook` instead.
+
+- The `deploy` script is updated to integrate the World interface changes
+
+**[refactor: remove v1 network package, remove snap sync module, deprecate std-client (#1311)](https://github.com/latticexyz/mud/commit/331f0d636f6f327824307570a63fb301d9b897d1)** (@latticexyz/world)
+
+The `SnapSyncModule` is removed. The recommended way of loading the initial state of a MUD app is via the new [`store-indexer`](https://mud.dev/indexer). Loading state via contract getter functions is not recommended, as it's computationally heavy on the RPC, can't be cached, and is an easy way to shoot yourself in the foot with exploding RPC costs.
+
+The `@latticexyz/network` package was deprecated and is now removed. All consumers should upgrade to the new sync stack from `@latticexyz/store-sync`.
+
+**[feat(store,world): combine schema and metadata registration, rename getSchema to getValueSchema, change Schema table id (#1182)](https://github.com/latticexyz/mud/commit/afaf2f5ffb36fe389a3aba8da2f6d8c84bdb26ab)** (@latticexyz/cli, @latticexyz/store, @latticexyz/world, @latticexyz/store-sync, create-mud)
+
+- `Store`'s internal schema table is now a normal table instead of using special code paths. It is renamed to Tables, and the table ID changed from `mudstore:schema` to `mudstore:Tables`
+- `Store`'s `registerSchema` and `setMetadata` are combined into a single `registerTable` method. This means metadata (key names, field names) is immutable and indexers can create tables with this metadata when a new table is registered on-chain.
+
+  ```diff
+  -  function registerSchema(bytes32 table, Schema schema, Schema keySchema) external;
+  -
+  -  function setMetadata(bytes32 table, string calldata tableName, string[] calldata fieldNames) external;
+
+  +  function registerTable(
+  +    bytes32 table,
+  +    Schema keySchema,
+  +    Schema valueSchema,
+  +    string[] calldata keyNames,
+  +    string[] calldata fieldNames
+  +  ) external;
+  ```
+
+- `World`'s `registerTable` method is updated to match the `Store` interface, `setMetadata` is removed
+- The `getSchema` method is renamed to `getValueSchema` on all interfaces
+  ```diff
+  - function getSchema(bytes32 table) external view returns (Schema schema);
+  + function getValueSchema(bytes32 table) external view returns (Schema valueSchema);
+  ```
+- The `store-sync` and `cli` packages are updated to integrate the breaking protocol changes. Downstream projects only need to manually integrate these changes if they access low level `Store` or `World` functions. Otherwise, a fresh deploy with the latest MUD will get you these changes.
+
+**[refactor: remove v1 network package, remove snap sync module, deprecate std-client (#1311)](https://github.com/latticexyz/mud/commit/331f0d636f6f327824307570a63fb301d9b897d1)** (@latticexyz/services, create-mud)
+
+Move `createFaucetService` from `@latticexyz/network` to `@latticexyz/services/faucet`.
+
+```diff
+- import { createFaucetService } from "@latticexyz/network";
++ import { createFaucetService } from "@latticexyz/services/faucet";
+```
+
+**[refactor: remove v1 network package, remove snap sync module, deprecate std-client (#1311)](https://github.com/latticexyz/mud/commit/331f0d636f6f327824307570a63fb301d9b897d1)** (@latticexyz/std-client, @latticexyz/common, create-mud)
+
+Deprecate `@latticexyz/std-client` and remove v1 network dependencies.
+
+- `getBurnerWallet` is replaced by `getBurnerPrivateKey` from `@latticexyz/common`. It now returns a `Hex` string instead of an `rxjs` `BehaviorSubject`.
+
+  ```
+  - import { getBurnerWallet } from "@latticexyz/std-client";
+  + import { getBurnerPrivateKey } from "@latticexyz/common";
+
+  - const privateKey = getBurnerWallet().value;
+  - const privateKey = getBurnerPrivateKey();
+  ```
+
+- All functions from `std-client` that depended on v1 network code are removed (most notably `setupMUDNetwork` and `setupMUDV2Network`). Consumers should upgrade to v2 networking code from `@latticexyz/store-sync`.
+
+- The following functions are removed from `std-client` because they are very use-case specific and depend on deprecated code: `getCurrentTurn`, `getTurnAtTime`, `getGameConfig`, `isUntraversable`, `getPlayerEntity`, `resolveRelationshipChain`, `findEntityWithComponentInRelationshipChain`, `findInRelationshipChain`. Consumers should vendor these functions if they are still needed.
+
+- Remaining exports from `std-client` are moved to `/deprecated`. The package will be removed in a future release (once there are replacements for the deprecated exports).
+
+  ```diff
+  - import { ... } from "@latticexyz/std-client";
+  + import { ... } from "@latticexyz/std-client/deprecated";
+  ```
+
+## Patch changes
+
+**[refactor(store): optimize table libraries (#1303)](https://github.com/latticexyz/mud/commit/d5b73b12666699c442d182ee904fa8747b78fefd)** (@latticexyz/store)
+
+Optimize autogenerated table libraries
+
+**[feat(store-sync): add more logging to waitForTransaction (#1317)](https://github.com/latticexyz/mud/commit/3e024fcf395a1c1b38d12362fc98472290eb7cf1)** (@latticexyz/store-sync)
+
+add retry attempts and more logging to `waitForTransaction`
+
+**[refactor(store): optimize Schema (#1252)](https://github.com/latticexyz/mud/commit/0d12db8c2170905f5116111e6bc417b6dca8eb61)** (@latticexyz/store, @latticexyz/world)
+
+Optimize Schema methods.
+Return `uint256` instead of `uint8` in SchemaInstance numFields methods
+
+---
+
 # Version 2.0.0-next.2
 
 ## Major changes

diff --git a/packages/block-logs-stream/CHANGELOG.md b/packages/block-logs-stream/CHANGELOG.md
@@ -1,5 +1,14 @@
 # @latticexyz/block-logs-stream
 
+## 2.0.0-next.3
+
+### Patch Changes
+
+- Updated dependencies [[`331f0d63`](https://github.com/latticexyz/mud/commit/331f0d636f6f327824307570a63fb301d9b897d1)]:
+  - @latticexyz/common@2.0.0-next.3
+  - @latticexyz/config@2.0.0-next.3
+  - @latticexyz/schema-type@2.0.0-next.3
+
 ## 2.0.0-next.2
 
 ### Major 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.2",
+  "version": "2.0.0-next.3",
   "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,76 @@
 # Change Log
 
+## 2.0.0-next.3
+
+### Major Changes
+
+- [#1174](https://github.com/latticexyz/mud/pull/1174) [`952cd534`](https://github.com/latticexyz/mud/commit/952cd534447d08e6231ab147ed1cc24fb49bbb57) Thanks [@alvrs](https://github.com/alvrs)! - All `Store` methods now require the table's value schema to be passed in as an argument instead of loading it from storage.
+  This decreases gas cost and removes circular dependencies of the Schema table (where it was not possible to write to the Schema table before the Schema table was registered).
+
+  ```diff
+    function setRecord(
+      bytes32 table,
+      bytes32[] calldata key,
+      bytes calldata data,
+  +   Schema valueSchema
+    ) external;
+  ```
+
+  The same diff applies to `getRecord`, `getField`, `setField`, `pushToField`, `popFromField`, `updateInField`, and `deleteRecord`.
+
+  This change only requires changes in downstream projects if the `Store` methods were accessed directly. In most cases it is fully abstracted in the generated table libraries,
+  so downstream projects only need to regenerate their table libraries after updating MUD.
+
+- [#1208](https://github.com/latticexyz/mud/pull/1208) [`c32a9269`](https://github.com/latticexyz/mud/commit/c32a9269a30c1898932ebbf7e3b60e25d1bd884c) Thanks [@alvrs](https://github.com/alvrs)! - - All `World` function selectors that previously had `bytes16 namespace, bytes16 name` arguments now use `bytes32 resourceSelector` instead.
+  This includes `setRecord`, `setField`, `pushToField`, `popFromField`, `updateInField`, `deleteRecord`, `call`, `grantAccess`, `revokeAccess`, `registerTable`,
+  `registerStoreHook`, `registerSystemHook`, `registerFunctionSelector`, `registerSystem` and `registerRootFunctionSelector`.
+  This change aligns the `World` function selectors with the `Store` function selectors, reduces clutter, reduces gas cost and reduces the `World`'s contract size.
+
+  - The `World`'s `registerHook` function is removed. Use `registerStoreHook` or `registerSystemHook` instead.
+
+  - The `deploy` script is updated to integrate the World interface changes
+
+- [#1182](https://github.com/latticexyz/mud/pull/1182) [`afaf2f5f`](https://github.com/latticexyz/mud/commit/afaf2f5ffb36fe389a3aba8da2f6d8c84bdb26ab) Thanks [@alvrs](https://github.com/alvrs)! - - `Store`'s internal schema table is now a normal table instead of using special code paths. It is renamed to Tables, and the table ID changed from `mudstore:schema` to `mudstore:Tables`
+
+  - `Store`'s `registerSchema` and `setMetadata` are combined into a single `registerTable` method. This means metadata (key names, field names) is immutable and indexers can create tables with this metadata when a new table is registered on-chain.
+
+    ```diff
+    -  function registerSchema(bytes32 table, Schema schema, Schema keySchema) external;
+    -
+    -  function setMetadata(bytes32 table, string calldata tableName, string[] calldata fieldNames) external;
+
+    +  function registerTable(
+    +    bytes32 table,
+    +    Schema keySchema,
+    +    Schema valueSchema,
+    +    string[] calldata keyNames,
+    +    string[] calldata fieldNames
+    +  ) external;
+    ```
+
+  - `World`'s `registerTable` method is updated to match the `Store` interface, `setMetadata` is removed
+  - The `getSchema` method is renamed to `getValueSchema` on all interfaces
+    ```diff
+    - function getSchema(bytes32 table) external view returns (Schema schema);
+    + function getValueSchema(bytes32 table) external view returns (Schema valueSchema);
+    ```
+  - The `store-sync` and `cli` packages are updated to integrate the breaking protocol changes. Downstream projects only need to manually integrate these changes if they access low level `Store` or `World` functions. Otherwise, a fresh deploy with the latest MUD will get you these changes.
+
+### Patch Changes
+
+- Updated dependencies [[`952cd534`](https://github.com/latticexyz/mud/commit/952cd534447d08e6231ab147ed1cc24fb49bbb57), [`c32a9269`](https://github.com/latticexyz/mud/commit/c32a9269a30c1898932ebbf7e3b60e25d1bd884c), [`331f0d63`](https://github.com/latticexyz/mud/commit/331f0d636f6f327824307570a63fb301d9b897d1), [`d5b73b12`](https://github.com/latticexyz/mud/commit/d5b73b12666699c442d182ee904fa8747b78fefd), [`afaf2f5f`](https://github.com/latticexyz/mud/commit/afaf2f5ffb36fe389a3aba8da2f6d8c84bdb26ab), [`331f0d63`](https://github.com/latticexyz/mud/commit/331f0d636f6f327824307570a63fb301d9b897d1), [`0d12db8c`](https://github.com/latticexyz/mud/commit/0d12db8c2170905f5116111e6bc417b6dca8eb61), [`331f0d63`](https://github.com/latticexyz/mud/commit/331f0d636f6f327824307570a63fb301d9b897d1)]:
+  - @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]
+  - @latticexyz/[email protected]
+
 ## 2.0.0-next.2
 
 ### Major 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.2",
+  "version": "2.0.0-next.3",
   "description": "Command line interface for mud",
   "repository": {
     "type": "git",

diff --git a/packages/common/CHANGELOG.md b/packages/common/CHANGELOG.md
@@ -1,5 +1,37 @@
 # Change Log
 
+## 2.0.0-next.3
+
+### Minor Changes
+
+- [#1311](https://github.com/latticexyz/mud/pull/1311) [`331f0d63`](https://github.com/latticexyz/mud/commit/331f0d636f6f327824307570a63fb301d9b897d1) Thanks [@alvrs](https://github.com/alvrs)! - Deprecate `@latticexyz/std-client` and remove v1 network dependencies.
+
+  - `getBurnerWallet` is replaced by `getBurnerPrivateKey` from `@latticexyz/common`. It now returns a `Hex` string instead of an `rxjs` `BehaviorSubject`.
+
+    ```
+    - import { getBurnerWallet } from "@latticexyz/std-client";
+    + import { getBurnerPrivateKey } from "@latticexyz/common";
+
+    - const privateKey = getBurnerWallet().value;
+    - const privateKey = getBurnerPrivateKey();
+    ```
+
+  - All functions from `std-client` that depended on v1 network code are removed (most notably `setupMUDNetwork` and `setupMUDV2Network`). Consumers should upgrade to v2 networking code from `@latticexyz/store-sync`.
+
+  - The following functions are removed from `std-client` because they are very use-case specific and depend on deprecated code: `getCurrentTurn`, `getTurnAtTime`, `getGameConfig`, `isUntraversable`, `getPlayerEntity`, `resolveRelationshipChain`, `findEntityWithComponentInRelationshipChain`, `findInRelationshipChain`. Consumers should vendor these functions if they are still needed.
+
+  - Remaining exports from `std-client` are moved to `/deprecated`. The package will be removed in a future release (once there are replacements for the deprecated exports).
+
+    ```diff
+    - import { ... } from "@latticexyz/std-client";
+    + import { ... } from "@latticexyz/std-client/deprecated";
+    ```
+
+### Patch Changes
+
+- Updated dependencies []:
+  - @latticexyz/[email protected]
+
 ## 2.0.0-next.2
 
 ### Minor 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.2",
+  "version": "2.0.0-next.3",
   "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.3
+
+### Patch Changes
+
+- Updated dependencies [[`331f0d63`](https://github.com/latticexyz/mud/commit/331f0d636f6f327824307570a63fb301d9b897d1)]:
+  - @latticexyz/common@2.0.0-next.3
+  - @latticexyz/schema-type@2.0.0-next.3
+
 ## 2.0.0-next.2
 
 ### 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.2",
+  "version": "2.0.0-next.3",
   "description": "Config for Store and World",
   "repository": {
     "type": "git",