Create metal-hounds-drum.md

latticexyz · Sep 14, 2023 · bb8cc29 · bb8cc29
1 parent 54e2e53
commit bb8cc29
Showing 1 changed file with 38 additions and 0 deletions.
diff --git a/.changeset/metal-hounds-drum.md b/.changeset/metal-hounds-drum.md
@@ -0,0 +1,38 @@
+---
+"@latticexyz/block-logs-stream": patch
+"@latticexyz/store-sync": patch
+"@latticexyz/store": patch
+---
+
+Renamed all occurrences of `table` where it is used as "table ID" to `tableId`.
+This is only a breaking change for consumers who manually decode `Store` events, but not for consumers who use the MUD libraries.
+
+```diff
+event StoreSetRecord(
+- bytes32 table,
++ bytes32 tableId,
+  bytes32[] key,
+  bytes data
+);
+
+event StoreSetField(
+- bytes32 table,
++ bytes32 tableId,
+  bytes32[] key,
+  uint8 fieldIndex,
+  bytes data
+);
+
+event StoreDeleteRecord(
+- bytes32 table,
++ bytes32 tableId,
+  bytes32[] key
+);
+
+event StoreEphemeralRecord(
+- bytes32 table,
++ bytes32 tableId,
+  bytes32[] key,
+  bytes data
+);
+```