Create hip-tables-check.md

latticexyz · Sep 18, 2023 · bfbade3 · bfbade3
1 parent fcbaa3d
commit bfbade3
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/.changeset/hip-tables-check.md b/.changeset/hip-tables-check.md
@@ -0,0 +1,14 @@
+---
+"@latticexyz/store": major
+"@latticexyz/world": major
+---
+
+Store's `getRecord` has been updated to return `staticData`, `encodedLengths`, and `dynamicData` instead of a single `data` blob, to match the new behaviour of Store setter methods.
+
+If you use codegenerated libraries, you will only need to update `encode` calls.
+
+ ```diff
+- bytes memory data = Mixed.encode(mixed.u32, mixed.u128, mixed.a32, mixed.s);
++ (bytes memory staticData, PackedCounter encodedLengths, bytes memory dynamicData) = Mixed.encode(mixed.u32, mixed.u128, mixed.a32, mixed.s);
+```
+