Version Packages (next)

latticexyz · Aug 9, 2023 · c1f3658 · c1f3658
1 parent 3f8124e
commit c1f3658
Show file tree

Hide file tree

Showing 56 changed files with 652 additions and 32 deletions.
diff --git a/.changeset/pre.json b/.changeset/pre.json
@@ -31,15 +31,28 @@
     "@latticexyz/world": "1.42.0"
   },
   "changesets": [
+    "afraid-hotels-bathe",
+    "big-goats-prove",
+    "brave-rings-tickle",
+    "dirty-items-retire",
     "eighty-tigers-argue",
     "fast-ears-hug",
+    "fifty-squids-eat",
+    "giant-masks-carry",
+    "great-cooks-dream",
     "itchy-kids-relax",
+    "itchy-shoes-appear",
+    "large-hats-walk",
     "many-phones-study",
+    "mean-pans-study",
+    "metal-cats-double",
     "modern-bikes-build",
     "nasty-waves-divide",
+    "nice-moose-love",
     "nice-pandas-knock",
     "olive-parrots-move",
     "perfect-mangos-cry",
+    "pink-horses-deny",
     "quick-numbers-flash",
     "rare-planes-draw",
     "selfish-cycles-retire",
@@ -49,6 +62,11 @@
     "strange-candles-shout",
     "strange-ducks-float",
     "thin-buses-reply",
-    "tricky-frogs-beam"
+    "tricky-frogs-beam",
+    "tricky-kangaroos-love",
+    "tricky-olives-stare",
+    "tricky-oranges-pump",
+    "weak-mails-cross",
+    "witty-jokes-serve"
   ]
 }
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,186 @@
+# Version 2.0.0-next.1
+
+## Major changes
+
+**[chore: fix changeset type (#1220)](https://github.com/latticexyz/mud/commit/2f6cfef91daacf09db82a4b7c69cff3af583b8f6)** (@latticexyz/store-indexer, @latticexyz/store-sync)
+
+Adds store indexer service package with utils to query the indexer service.
+
+You can run the indexer locally by checking out the MUD monorepo, installing/building everything, and running `pnpm start:local` from `packages/store-indexer`.
+
+To query the indexer in the client, you can create a tRPC client with a URL pointing to the indexer service and call the available tRPC methods:
+
+```ts
+import { createIndexerClient } from "@latticexyz/store-sync/trpc-indexer";
+
+const indexer = createIndexerClient({ url: indexerUrl });
+const result = await indexer.findAll.query({
+  chainId: publicClient.chain.id,
+  address,
+});
+```
+
+If you're using `syncToRecs`, you can just pass in the `indexerUrl` option as a shortcut to the above:
+
+```ts
+import { syncToRecs } from "@latticexyz/store-sync/recs";
+
+syncToRecs({
+  ...
+  indexerUrl: "https://your.indexer.service",
+});
+```
+
+**[feat(common): replace TableId with tableIdToHex/hexToTableId (#1258)](https://github.com/latticexyz/mud/commit/6c6733256f91cddb0e913217cbd8e02e6bc484c7)** (@latticexyz/cli, @latticexyz/common, @latticexyz/dev-tools, @latticexyz/network, @latticexyz/std-client, @latticexyz/store-sync)
+
+Add `tableIdToHex` and `hexToTableId` pure functions and move/deprecate `TableId`.
+
+**[feat(common): add createContract, createNonceManager utils (#1261)](https://github.com/latticexyz/mud/commit/cd5abcc3b4744fab9a45c322bc76ff013355ffcb)** (@latticexyz/common)
+
+Add utils for using viem with MUD
+
+- `createContract` is a wrapper around [viem's `getContract`](https://viem.sh/docs/contract/getContract.html) but with better nonce handling for faster executing of transactions. It has the same arguments and return type as `getContract`.
+- `createNonceManager` helps track local nonces, used by `createContract`.
+
+Also renames `mudTransportObserver` to `transportObserver`.
+
+## Minor changes
+
+**[feat(common): add viem utils (#1245)](https://github.com/latticexyz/mud/commit/3fb9ce2839271a0dcfe97f86394195f7a6f70f50)** (@latticexyz/common)
+
+Add utils for using viem with MUD
+
+- `mudFoundry` chain with a transaction request formatter that temporarily removes max fees to work better with anvil `--base-fee 0`
+- `createBurnerAccount` that also temporarily removes max fees during transaction signing to work better with anvil `--base-fee 0`
+- `mudTransportObserver` that will soon let MUD Dev Tools observe transactions
+
+You can use them like:
+
+```ts
+import { createBurnerAccount, mudTransportObserver } from "@latticexyz/common";
+import { mudFoundry } from "@latticexyz/common/chains";
+
+createWalletClient({
+  account: createBurnerAccount(privateKey),
+  chain: mudFoundry,
+  transport: mudTransportObserver(http()),
+  pollingInterval: 1000,
+});
+```
+
+**[feat(store-indexer,store-sync): make chain optional, configure indexer with RPC (#1234)](https://github.com/latticexyz/mud/commit/131c63e539a8e9947835dcc323c8b37562aed9ca)** (@latticexyz/store-indexer, @latticexyz/store-sync)
+
+- Accept a plain viem `PublicClient` (instead of requiring a `Chain` to be set) in `store-sync` and `store-indexer` functions. These functions now fetch chain ID using `publicClient.getChainId()` when no `publicClient.chain.id` is present.
+- Allow configuring `store-indexer` with a set of RPC URLs (`RPC_HTTP_URL` and `RPC_WS_URL`) instead of `CHAIN_ID`.
+
+**[feat(store-sync): export singletonEntity as const, allow startBlock in syncToRecs (#1235)](https://github.com/latticexyz/mud/commit/582388ba5f95c3efde56779058220dbd7aedee0b)** (@latticexyz/store-sync)
+
+Export `singletonEntity` as const rather than within the `syncToRecs` result.
+
+```diff
+- const { singletonEntity, ... } = syncToRecs({ ... });
++ import { singletonEntity, syncToRecs } from "@latticexyz/store-sync/recs";
++ const { ... } = syncToRecs({ ... });
+```
+
+**[feat(schema-type): add type narrowing isStaticAbiType (#1196)](https://github.com/latticexyz/mud/commit/b02f9d0e43089e5f9b46d817ea2032ce0a1b0b07)** (@latticexyz/schema-type)
+
+add type narrowing `isStaticAbiType`
+
+**[feat(common): move zero gas fee override to `createContract` (#1266)](https://github.com/latticexyz/mud/commit/6071163f70599384c5034dd772ef6fc7cdae9983)** (@latticexyz/common)
+
+- Moves zero gas fee override to `createContract` until https://github.com/wagmi-dev/viem/pull/963 or similar feature lands
+- Skip simulation if `gas` is provided
+
+## Patch changes
+
+**[fix(cli): add support for legacy transactions in deploy script (#1178)](https://github.com/latticexyz/mud/commit/168a4cb43ce4f7bfbdb7b1b9d4c305b912a0d3f2)** (@latticexyz/cli)
+
+Add support for legacy transactions in deploy script by falling back to `gasPrice` if `lastBaseFeePerGas` is not available
+
+**[feat: protocol-parser in go (#1116)](https://github.com/latticexyz/mud/commit/3236f799e501be227da6e42e7b41a4928750115c)** (@latticexyz/services)
+
+protocol-parser in Go
+
+**[refactor(store): optimize Storage library (#1194)](https://github.com/latticexyz/mud/commit/c963b46c7eaceebc652930936643365b8c48a021)** (@latticexyz/store)
+
+Optimize storage library
+
+**[feat(store-sync): add block numbers to SyncProgress (#1228)](https://github.com/latticexyz/mud/commit/57a5260830401c9ad93196a895a50b0fc4a86183)** (@latticexyz/store-sync)
+
+Adds `latestBlockNumber` and `lastBlockNumberProcessed` to internal `SyncProgress` component
+
+**[feat(store-sync): sync to RECS (#1197)](https://github.com/latticexyz/mud/commit/9e5baf4fff0c60615b8f2b4645fb11cb78cb0bd8)** (@latticexyz/store-sync)
+
+Add RECS sync strategy and corresponding utils
+
+```ts
+import { createPublicClient, http } from 'viem';
+import { syncToRecs } from '@latticexyz/store-sync';
+import storeConfig from 'contracts/mud.config';
+import { defineContractComponents } from './defineContractComponents';
+
+const publicClient = createPublicClient({
+  chain,
+  transport: http(),
+  pollingInterval: 1000,
+});
+
+const { components, singletonEntity, latestBlock$, blockStorageOperations$, waitForTransaction } = await syncToRecs({
+  world,
+  config: storeConfig,
+  address: '0x...',
+  publicClient,
+  components: defineContractComponents(...),
+});
+```
+
+**[fix(store): align Store event names between IStoreWrite and StoreCore (#1237)](https://github.com/latticexyz/mud/commit/5c965a919355bf98d7ea69463890fe605bcde206)** (@latticexyz/store)
+
+Align Store events parameter naming between IStoreWrite and StoreCore
+
+**[fix(cli): explicit import of world as type (#1206)](https://github.com/latticexyz/mud/commit/e259ef79f4d9026353176d0f74628cae50c2f69b)** (@latticexyz/cli, @latticexyz/std-client)
+
+Generated `contractComponents` now properly import `World` as type
+
+**[feat(store-sync): export singletonEntity as const, allow startBlock in syncToRecs (#1235)](https://github.com/latticexyz/mud/commit/582388ba5f95c3efde56779058220dbd7aedee0b)** (@latticexyz/store-sync)
+
+Add `startBlock` option to `syncToRecs`.
+
+```ts
+import { syncToRecs } from "@latticexyz/store-sync/recs";
+import worlds from "contracts/worlds.json";
+
+syncToRecs({
+  startBlock: worlds['31337'].blockNumber,
+  ...
+});
+```
+
+**[feat(store-sync): sync to sqlite (#1185)](https://github.com/latticexyz/mud/commit/69a96f109065ae2564a340208d5f9a0be3616747)** (@latticexyz/network)
+
+Remove devEmit function when sending network events from SyncWorker because they can't be serialized across the web worker boundary.
+
+**[feat(cli,recs,std-client): update RECS components with v2 key/value schemas (#1195)](https://github.com/latticexyz/mud/commit/afdba793fd84abf17eef5ef59dd56fabe353c8bd)** (@latticexyz/cli, @latticexyz/recs, @latticexyz/std-client)
+
+Update RECS components with v2 key/value schemas. This helps with encoding/decoding composite keys and strong types for keys/values.
+
+This may break if you were previously dependent on `component.id`, `component.metadata.componentId`, or `component.metadata.tableId`:
+
+- `component.id` is now the on-chain `bytes32` hex representation of the table ID
+- `component.metadata.componentName` is the table name (e.g. `Position`)
+- `component.metadata.tableName` is the namespaced table name (e.g. `myworld:Position`)
+- `component.metadata.keySchema` is an object with key names and their corresponding ABI types
+- `component.metadata.valueSchema` is an object with field names and their corresponding ABI types
+
+**[refactor(store): update tightcoder codegen, optimize TightCoder library (#1210)](https://github.com/latticexyz/mud/commit/cc2c8da000c32c02a82a1a0fd17075d11eac56c3)** (@latticexyz/common, @latticexyz/store, @latticexyz/world)
+
+- Refactor tightcoder to use typescript functions instead of ejs
+- Optimize `TightCoder` library
+- Add `isLeftAligned` and `getLeftPaddingBits` common codegen helpers
+
+---
+
 # Version 2.0.0-next.0
 
 ## Minor 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.1
+
+### Patch Changes
+
+- Updated dependencies [[`3fb9ce28`](https://github.com/latticexyz/mud/commit/3fb9ce2839271a0dcfe97f86394195f7a6f70f50), [`b02f9d0e`](https://github.com/latticexyz/mud/commit/b02f9d0e43089e5f9b46d817ea2032ce0a1b0b07), [`6071163f`](https://github.com/latticexyz/mud/commit/6071163f70599384c5034dd772ef6fc7cdae9983), [`6c673325`](https://github.com/latticexyz/mud/commit/6c6733256f91cddb0e913217cbd8e02e6bc484c7), [`cd5abcc3`](https://github.com/latticexyz/mud/commit/cd5abcc3b4744fab9a45c322bc76ff013355ffcb), [`cc2c8da0`](https://github.com/latticexyz/mud/commit/cc2c8da000c32c02a82a1a0fd17075d11eac56c3)]:
+  - @latticexyz/common@2.0.0-next.1
+  - @latticexyz/schema-type@2.0.0-next.1
+  - @latticexyz/config@2.0.0-next.1
+
 ## 2.0.0-next.0
 
 ### Minor 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.0",
+  "version": "2.0.0-next.1",
   "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,37 @@
 # Change Log
 
+## 2.0.0-next.1
+
+### Patch Changes
+
+- [#1178](https://github.com/latticexyz/mud/pull/1178) [`168a4cb4`](https://github.com/latticexyz/mud/commit/168a4cb43ce4f7bfbdb7b1b9d4c305b912a0d3f2) Thanks [@TheGreatAxios](https://github.com/TheGreatAxios)! - Add support for legacy transactions in deploy script by falling back to `gasPrice` if `lastBaseFeePerGas` is not available
+
+- [#1206](https://github.com/latticexyz/mud/pull/1206) [`e259ef79`](https://github.com/latticexyz/mud/commit/e259ef79f4d9026353176d0f74628cae50c2f69b) Thanks [@holic](https://github.com/holic)! - Generated `contractComponents` now properly import `World` as type
+
+- [#1258](https://github.com/latticexyz/mud/pull/1258) [`6c673325`](https://github.com/latticexyz/mud/commit/6c6733256f91cddb0e913217cbd8e02e6bc484c7) Thanks [@holic](https://github.com/holic)! - Add `tableIdToHex` and `hexToTableId` pure functions and move/deprecate `TableId`.
+
+- [#1195](https://github.com/latticexyz/mud/pull/1195) [`afdba793`](https://github.com/latticexyz/mud/commit/afdba793fd84abf17eef5ef59dd56fabe353c8bd) Thanks [@holic](https://github.com/holic)! - Update RECS components with v2 key/value schemas. This helps with encoding/decoding composite keys and strong types for keys/values.
+
+  This may break if you were previously dependent on `component.id`, `component.metadata.componentId`, or `component.metadata.tableId`:
+
+  - `component.id` is now the on-chain `bytes32` hex representation of the table ID
+  - `component.metadata.componentName` is the table name (e.g. `Position`)
+  - `component.metadata.tableName` is the namespaced table name (e.g. `myworld:Position`)
+  - `component.metadata.keySchema` is an object with key names and their corresponding ABI types
+  - `component.metadata.valueSchema` is an object with field names and their corresponding ABI types
+
+- Updated dependencies [[`3236f799`](https://github.com/latticexyz/mud/commit/3236f799e501be227da6e42e7b41a4928750115c), [`c963b46c`](https://github.com/latticexyz/mud/commit/c963b46c7eaceebc652930936643365b8c48a021), [`3fb9ce28`](https://github.com/latticexyz/mud/commit/3fb9ce2839271a0dcfe97f86394195f7a6f70f50), [`5c965a91`](https://github.com/latticexyz/mud/commit/5c965a919355bf98d7ea69463890fe605bcde206), [`b02f9d0e`](https://github.com/latticexyz/mud/commit/b02f9d0e43089e5f9b46d817ea2032ce0a1b0b07), [`6071163f`](https://github.com/latticexyz/mud/commit/6071163f70599384c5034dd772ef6fc7cdae9983), [`6c673325`](https://github.com/latticexyz/mud/commit/6c6733256f91cddb0e913217cbd8e02e6bc484c7), [`cd5abcc3`](https://github.com/latticexyz/mud/commit/cd5abcc3b4744fab9a45c322bc76ff013355ffcb), [`cc2c8da0`](https://github.com/latticexyz/mud/commit/cc2c8da000c32c02a82a1a0fd17075d11eac56c3)]:
+  - @latticexyz/services@2.0.0-next.1
+  - @latticexyz/store@2.0.0-next.1
+  - @latticexyz/common@2.0.0-next.1
+  - @latticexyz/schema-type@2.0.0-next.1
+  - @latticexyz/world@2.0.0-next.1
+  - @latticexyz/config@2.0.0-next.1
+  - @latticexyz/utils@2.0.0-next.1
+  - @latticexyz/gas-report@2.0.0-next.1
+  - @latticexyz/solecs@2.0.0-next.1
+  - @latticexyz/std-contracts@2.0.0-next.1
+
 ## 2.0.0-next.0
 
 ### Minor 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.0",
+  "version": "2.0.0-next.1",
   "description": "Command line interface for mud",
   "repository": {
     "type": "git",

diff --git a/packages/common/CHANGELOG.md b/packages/common/CHANGELOG.md
@@ -1,5 +1,51 @@
 # Change Log
 
+## 2.0.0-next.1
+
+### Major Changes
+
+- [#1258](https://github.com/latticexyz/mud/pull/1258) [`6c673325`](https://github.com/latticexyz/mud/commit/6c6733256f91cddb0e913217cbd8e02e6bc484c7) Thanks [@holic](https://github.com/holic)! - Add `tableIdToHex` and `hexToTableId` pure functions and move/deprecate `TableId`.
+
+- [#1261](https://github.com/latticexyz/mud/pull/1261) [`cd5abcc3`](https://github.com/latticexyz/mud/commit/cd5abcc3b4744fab9a45c322bc76ff013355ffcb) Thanks [@holic](https://github.com/holic)! - Add utils for using viem with MUD
+
+  - `createContract` is a wrapper around [viem's `getContract`](https://viem.sh/docs/contract/getContract.html) but with better nonce handling for faster executing of transactions. It has the same arguments and return type as `getContract`.
+  - `createNonceManager` helps track local nonces, used by `createContract`.
+
+  Also renames `mudTransportObserver` to `transportObserver`.
+
+### Minor Changes
+
+- [#1245](https://github.com/latticexyz/mud/pull/1245) [`3fb9ce28`](https://github.com/latticexyz/mud/commit/3fb9ce2839271a0dcfe97f86394195f7a6f70f50) Thanks [@holic](https://github.com/holic)! - Add utils for using viem with MUD
+
+  - `mudFoundry` chain with a transaction request formatter that temporarily removes max fees to work better with anvil `--base-fee 0`
+  - `createBurnerAccount` that also temporarily removes max fees during transaction signing to work better with anvil `--base-fee 0`
+  - `mudTransportObserver` that will soon let MUD Dev Tools observe transactions
+
+  You can use them like:
+
+  ```ts
+  import { createBurnerAccount, mudTransportObserver } from "@latticexyz/common";
+  import { mudFoundry } from "@latticexyz/common/chains";
+
+  createWalletClient({
+    account: createBurnerAccount(privateKey),
+    chain: mudFoundry,
+    transport: mudTransportObserver(http()),
+    pollingInterval: 1000,
+  });
+  ```
+
+- [#1266](https://github.com/latticexyz/mud/pull/1266) [`6071163f`](https://github.com/latticexyz/mud/commit/6071163f70599384c5034dd772ef6fc7cdae9983) Thanks [@holic](https://github.com/holic)! - - Moves zero gas fee override to `createContract` until https://github.com/wagmi-dev/viem/pull/963 or similar feature lands
+  - Skip simulation if `gas` is provided
+
+### Patch Changes
+
+- [#1210](https://github.com/latticexyz/mud/pull/1210) [`cc2c8da0`](https://github.com/latticexyz/mud/commit/cc2c8da000c32c02a82a1a0fd17075d11eac56c3) Thanks [@dk1a](https://github.com/dk1a)! - - Refactor tightcoder to use typescript functions instead of ejs
+  - Optimize `TightCoder` library
+  - Add `isLeftAligned` and `getLeftPaddingBits` common codegen helpers
+- Updated dependencies [[`b02f9d0e`](https://github.com/latticexyz/mud/commit/b02f9d0e43089e5f9b46d817ea2032ce0a1b0b07)]:
+  - @latticexyz/schema-type@2.0.0-next.1
+
 ## 2.0.0-next.0
 
 ### 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.0",
+  "version": "2.0.0-next.1",
   "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.1
+
+### Patch Changes
+
+- Updated dependencies [[`3fb9ce28`](https://github.com/latticexyz/mud/commit/3fb9ce2839271a0dcfe97f86394195f7a6f70f50), [`b02f9d0e`](https://github.com/latticexyz/mud/commit/b02f9d0e43089e5f9b46d817ea2032ce0a1b0b07), [`6071163f`](https://github.com/latticexyz/mud/commit/6071163f70599384c5034dd772ef6fc7cdae9983), [`6c673325`](https://github.com/latticexyz/mud/commit/6c6733256f91cddb0e913217cbd8e02e6bc484c7), [`cd5abcc3`](https://github.com/latticexyz/mud/commit/cd5abcc3b4744fab9a45c322bc76ff013355ffcb), [`cc2c8da0`](https://github.com/latticexyz/mud/commit/cc2c8da000c32c02a82a1a0fd17075d11eac56c3)]:
+  - @latticexyz/common@2.0.0-next.1
+  - @latticexyz/schema-type@2.0.0-next.1
+
 ## 2.0.0-next.0
 
 ### 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.0",
+  "version": "2.0.0-next.1",
   "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.1
+
 ## 2.0.0-next.0
 
 ### Patch Changes

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.0",
+  "version": "2.0.0-next.1",
   "description": "Create a new MUD project",
   "license": "MIT",
   "author": "Lattice <mud@lattice.xyz>",