Version Packages (#3202)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
latticexyz · Sep 19, 2024 · 512ddc4 · 512ddc4
1 parent 652c9aa
commit 512ddc4
Show file tree

Hide file tree

Showing 57 changed files with 324 additions and 66 deletions.
diff --git a/.changeset/chatty-pigs-shake.md b/.changeset/chatty-pigs-shake.md
diff --git a/.changeset/few-olives-judge.md b/.changeset/few-olives-judge.md
diff --git a/.changeset/lucky-cows-fail.md b/.changeset/lucky-cows-fail.md
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,48 @@
+## Version 2.2.6
+
+Release date: Thu Sep 19 2024
+
+### Patch changes
+
+**[feat(stash): release package to npm (#3184)](https://github.com/latticexyz/mud/commit/20fac30f2fb1e026f195ffe42c014cfaf9877376)** (@latticexyz/stash)
+
+Added `@latticexyz/stash` package, a TypeScript client state library optimized for the MUD Store data model.
+It uses the MUD store config to define local tables, which support writing, reading and subscribing to table updates.
+It comes with a query engine optimized for "ECS-style" queries (similar to `@latticexyz/recs`) but with native support for composite keys.
+
+You can find usage examples in the [`@latticexyz/stash` README.md](https://github.com/latticexyz/mud/blob/main/packages/stash/README.md).
+
+This package is experimental and will have breaking changes while we refine its APIs and implementation. All of its exports are temporarily under `@latticexyz/stash/internal` until we consider it stable.
+
+**[fix(cli): improve performance of linked library resolution during deployment (#3197)](https://github.com/latticexyz/mud/commit/22c37c3dbec5726f52055ed61c4e5f0e52ed30c1)** (@latticexyz/cli)
+
+Significantly improved the deployment performance for large projects with public libraries by implementing a more efficient algorithm to resolve public libraries during deployment.
+The local deployment time on a large reference project was reduced from over 10 minutes to 4 seconds.
+
+**[feat(store-sync): add syncToStash util (#3192)](https://github.com/latticexyz/mud/commit/8dc588918c488f98603cbb7e183c88129942debe)** (@latticexyz/store-sync)
+
+Added a `syncToStash` util to hydrate a `stash` client store from MUD contract state. This is currently exported from `@latticexyz/store-sync/internal` while Stash package is unstable/experimental.
+
+```ts
+import { createClient, http } from "viem";
+import { anvil } from "viem/chains";
+import { createStash } from "@latticexyz/stash/internal";
+import { syncToStash } from "@latticexyz/store-sync/internal";
+import config from "../mud.config";
+
+const client = createClient({
+  chain: anvil,
+  transport: http(),
+});
+
+const address = "0x...";
+
+const stash = createStash(config);
+const sync = await syncToStash({ stash, client, address });
+```
+
+---
+
 ## Version 2.2.5
 
 Release date: Thu Sep 19 2024

diff --git a/docs/pages/changelog.mdx b/docs/pages/changelog.mdx
@@ -1,3 +1,48 @@
+## Version 2.2.6
+
+Release date: Thu Sep 19 2024
+
+### Patch changes
+
+**[feat(stash): release package to npm (#3184)](https://github.com/latticexyz/mud/commit/20fac30f2fb1e026f195ffe42c014cfaf9877376)** (@latticexyz/stash)
+
+Added `@latticexyz/stash` package, a TypeScript client state library optimized for the MUD Store data model.
+It uses the MUD store config to define local tables, which support writing, reading and subscribing to table updates.
+It comes with a query engine optimized for "ECS-style" queries (similar to `@latticexyz/recs`) but with native support for composite keys.
+
+You can find usage examples in the [`@latticexyz/stash` README.md](https://github.com/latticexyz/mud/blob/main/packages/stash/README.md).
+
+This package is experimental and will have breaking changes while we refine its APIs and implementation. All of its exports are temporarily under `@latticexyz/stash/internal` until we consider it stable.
+
+**[fix(cli): improve performance of linked library resolution during deployment (#3197)](https://github.com/latticexyz/mud/commit/22c37c3dbec5726f52055ed61c4e5f0e52ed30c1)** (@latticexyz/cli)
+
+Significantly improved the deployment performance for large projects with public libraries by implementing a more efficient algorithm to resolve public libraries during deployment.
+The local deployment time on a large reference project was reduced from over 10 minutes to 4 seconds.
+
+**[feat(store-sync): add syncToStash util (#3192)](https://github.com/latticexyz/mud/commit/8dc588918c488f98603cbb7e183c88129942debe)** (@latticexyz/store-sync)
+
+Added a `syncToStash` util to hydrate a `stash` client store from MUD contract state. This is currently exported from `@latticexyz/store-sync/internal` while Stash package is unstable/experimental.
+
+```ts
+import { createClient, http } from "viem";
+import { anvil } from "viem/chains";
+import { createStash } from "@latticexyz/stash/internal";
+import { syncToStash } from "@latticexyz/store-sync/internal";
+import config from "../mud.config";
+
+const client = createClient({
+  chain: anvil,
+  transport: http(),
+});
+
+const address = "0x...";
+
+const stash = createStash(config);
+const sync = await syncToStash({ stash, client, address });
+```
+
+---
+
 ## Version 2.2.5
 
 Release date: Thu Sep 19 2024

diff --git a/packages/abi-ts/CHANGELOG.md b/packages/abi-ts/CHANGELOG.md
@@ -1,5 +1,7 @@
 # @latticexyz/abi-ts
 
+## 2.2.6
+
 ## 2.2.5
 
 ## 2.2.4

diff --git a/packages/abi-ts/package.json b/packages/abi-ts/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@latticexyz/abi-ts",
-  "version": "2.2.5",
+  "version": "2.2.6",
   "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,11 @@
 # @latticexyz/block-logs-stream
 
+## 2.2.6
+
+### Patch Changes
+
+- @latticexyz/common@2.2.6
+
 ## 2.2.5
 
 ### 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.2.5",
+  "version": "2.2.6",
   "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,22 @@
 # Change Log
 
+## 2.2.6
+
+### Patch Changes
+
+- 22c37c3: Significantly improved the deployment performance for large projects with public libraries by implementing a more efficient algorithm to resolve public libraries during deployment.
+  The local deployment time on a large reference project was reduced from over 10 minutes to 4 seconds.
+  - @latticexyz/abi-ts@2.2.6
+  - @latticexyz/common@2.2.6
+  - @latticexyz/config@2.2.6
+  - @latticexyz/gas-report@2.2.6
+  - @latticexyz/protocol-parser@2.2.6
+  - @latticexyz/schema-type@2.2.6
+  - @latticexyz/store@2.2.6
+  - @latticexyz/utils@2.2.6
+  - @latticexyz/world@2.2.6
+  - @latticexyz/world-module-metadata@2.2.6
+
 ## 2.2.5
 
 ### Patch Changes

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

diff --git a/packages/common/CHANGELOG.md b/packages/common/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Change Log
 
+## 2.2.6
+
+### Patch Changes
+
+- @latticexyz/schema-type@2.2.6
+
 ## 2.2.5
 
 ### Patch Changes

diff --git a/packages/common/package.json b/packages/common/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@latticexyz/common",
-  "version": "2.2.5",
+  "version": "2.2.6",
   "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,12 @@
 # Change Log
 
+## 2.2.6
+
+### Patch Changes
+
+- @latticexyz/common@2.2.6
+- @latticexyz/schema-type@2.2.6
+
 ## 2.2.5
 
 ### Patch Changes

diff --git a/packages/config/package.json b/packages/config/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@latticexyz/config",
-  "version": "2.2.5",
+  "version": "2.2.6",
   "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.2.6
+
 ## 2.2.5
 
 ## 2.2.4

diff --git a/packages/create-mud/package.json b/packages/create-mud/package.json
@@ -1,6 +1,6 @@
 {
   "name": "create-mud",
-  "version": "2.2.5",
+  "version": "2.2.6",
   "description": "Create a new MUD project",
   "license": "MIT",
   "author": "Lattice <mud@lattice.xyz>",

diff --git a/packages/dev-tools/CHANGELOG.md b/packages/dev-tools/CHANGELOG.md
@@ -1,5 +1,19 @@
 # @latticexyz/dev-tools
 
+## 2.2.6
+
+### Patch Changes
+
+- Updated dependencies [8dc5889]
+  - @latticexyz/store-sync@2.2.6
+  - @latticexyz/common@2.2.6
+  - @latticexyz/react@2.2.6
+  - @latticexyz/recs@2.2.6
+  - @latticexyz/schema-type@2.2.6
+  - @latticexyz/store@2.2.6
+  - @latticexyz/utils@2.2.6
+  - @latticexyz/world@2.2.6
+
 ## 2.2.5
 
 ### 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.2.5",
+  "version": "2.2.6",
   "description": "MUD developer tools",
   "repository": {
     "type": "git",

diff --git a/packages/explorer/CHANGELOG.md b/packages/explorer/CHANGELOG.md
@@ -1,5 +1,17 @@
 # @latticexyz/explorer
 
+## 2.2.6
+
+### Patch Changes
+
+- Updated dependencies [8dc5889]
+  - @latticexyz/store-sync@2.2.6
+  - @latticexyz/common@2.2.6
+  - @latticexyz/protocol-parser@2.2.6
+  - @latticexyz/schema-type@2.2.6
+  - @latticexyz/store@2.2.6
+  - @latticexyz/world@2.2.6
+
 ## 2.2.5
 
 ### Patch Changes

diff --git a/packages/explorer/package.json b/packages/explorer/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@latticexyz/explorer",
-  "version": "2.2.5",
+  "version": "2.2.6",
   "description": "World Explorer is a tool for visually exploring and manipulating the state of worlds",
   "type": "module",
   "exports": {

diff --git a/packages/faucet/CHANGELOG.md b/packages/faucet/CHANGELOG.md
@@ -1,5 +1,11 @@
 # @latticexyz/faucet
 
+## 2.2.6
+
+### Patch Changes
+
+- @latticexyz/common@2.2.6
+
 ## 2.2.5
 
 ### Patch Changes

diff --git a/packages/faucet/package.json b/packages/faucet/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@latticexyz/faucet",
-  "version": "2.2.5",
+  "version": "2.2.6",
   "description": "Faucet API for Lattice testnet",
   "repository": {
     "type": "git",

diff --git a/packages/gas-report/CHANGELOG.md b/packages/gas-report/CHANGELOG.md
@@ -1,5 +1,7 @@
 # Change Log
 
+## 2.2.6
+
 ## 2.2.5
 
 ## 2.2.4

diff --git a/packages/gas-report/package.json b/packages/gas-report/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@latticexyz/gas-report",
-  "version": "2.2.5",
+  "version": "2.2.6",
   "description": "Gas reporter for specific lines within forge tests",
   "repository": {
     "type": "git",

diff --git a/packages/protocol-parser/CHANGELOG.md b/packages/protocol-parser/CHANGELOG.md
@@ -1,5 +1,13 @@
 # @latticexyz/protocol-parser
 
+## 2.2.6
+
+### Patch Changes
+
+- @latticexyz/common@2.2.6
+- @latticexyz/config@2.2.6
+- @latticexyz/schema-type@2.2.6
+
 ## 2.2.5
 
 ### Patch Changes

diff --git a/packages/protocol-parser/package.json b/packages/protocol-parser/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@latticexyz/protocol-parser",
-  "version": "2.2.5",
+  "version": "2.2.6",
   "description": "Parser utilities for the MUD protocol",
   "repository": {
     "type": "git",

diff --git a/packages/react/CHANGELOG.md b/packages/react/CHANGELOG.md
@@ -1,5 +1,12 @@
 # Change Log
 
+## 2.2.6
+
+### Patch Changes
+
+- @latticexyz/recs@2.2.6
+- @latticexyz/store@2.2.6
+
 ## 2.2.5
 
 ### Patch Changes

diff --git a/packages/react/package.json b/packages/react/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@latticexyz/react",
-  "version": "2.2.5",
+  "version": "2.2.6",
   "description": "React tools for MUD client.",
   "repository": {
     "type": "git",