feat(store): rename events for readability and consistency with errors (

#1577)
latticexyz · Sep 22, 2023 · af639a2 · af639a2
1 parent e5d208e
commit af639a2
Show file tree

Hide file tree

Showing 22 changed files with 476 additions and 408 deletions.
diff --git a/.changeset/stale-schools-wait.md b/.changeset/stale-schools-wait.md
@@ -0,0 +1,43 @@
+---
+"@latticexyz/block-logs-stream": patch
+"@latticexyz/dev-tools": patch
+"@latticexyz/store-sync": patch
+"@latticexyz/store": major
+---
+
+`Store` events have been renamed for consistency and readability.
+If you're parsing `Store` events manually, you need to update your ABI.
+If you're using the MUD sync stack, the new events are already integrated and no further changes are necessary.
+
+```diff
+- event StoreSetRecord(
++ event Store_SetRecord(
+    ResourceId indexed tableId,
+    bytes32[] keyTuple,
+    bytes staticData,
+    bytes32 encodedLengths,
+    bytes dynamicData
+  );
+- event StoreSpliceStaticData(
++ event Store_SpliceStaticData(
+    ResourceId indexed tableId,
+    bytes32[] keyTuple,
+    uint48 start,
+    uint40 deleteCount,
+    bytes data
+  );
+- event StoreSpliceDynamicData(
++ event Store_SpliceDynamicData(
+    ResourceId indexed tableId,
+    bytes32[] keyTuple,
+    uint48 start,
+    uint40 deleteCount,
+    bytes data,
+    bytes32 encodedLengths
+  );
+- event StoreDeleteRecord(
++ event Store_DeleteRecord(
+    ResourceId indexed tableId,
+    bytes32[] keyTuple
+  );
+```
diff --git a/docs/pages/store/spec.mdx b/docs/pages/store/spec.mdx
@@ -7,9 +7,10 @@ import { Aside } from "../../components/Aside";
 When a record or a single field is edited, or when a record is deleted, Store emits a standard event with enough information for off-chain actors to reconstruct the new version of the Store with event-sourcing.
 
 ```solidity
-event StoreSetRecord(uint256 tableId, bytes32[] keyTuple, bytes data);
-event StoreSetField(uint256 tableId, bytes32[] keyTuple, uint8 schemaIndex, bytes data);
-event StoreDeleteRecord(uint256 tableId, bytes32[] keyTuple);
+event Store_SetRecord(bytes32 indexed tableId, bytes32[] keyTuple, bytes staticData, bytes32 encodedLengths, bytes dynamicData),
+event Store_SpliceStaticData(bytes32 indexed tableId, bytes32[] keyTuple, uint48 start, uint40 deleteCount, bytes data),
+event Store_SpliceDynamicData(bytes32 indexed tableId, bytes32[] keyTuple, uint48 start, uint40 deleteCount, bytes data, bytes32 encodedLengths),
+event Store_DeleteRecord(bytes32 indexed tableId, bytes32[] keyTuple),
 ```
 
 Each event includes the table ID and each key encoded as `bytes32`.
@@ -22,7 +23,7 @@ MUD comes with many libraries and services in order to reconstruct the state of
 ### Data encoding
 
 `bytes data` uses custom encoding, which MUD networking stack decodes.
-Each event carries only data. To get a table's schema (information on how to decode it), use `IStore.getSchema(tableId)` or listen to `StoreSetRecord` updates of the schema table.
+Each event carries only data. To get a table's schema (information on how to decode it), use `IStore.getSchema(tableId)` or listen to `Store_SetRecord` updates of the schema table.
 
 Schema is a way to dynamically store solidity types.
 Use the [schema-type package](https://github.com/latticexyz/mud/tree/main/packages/schema-type) to work with it directly.

diff --git a/examples/minimal/packages/contracts/test/ChatNamespaced.t.sol b/examples/minimal/packages/contracts/test/ChatNamespaced.t.sol
@@ -15,7 +15,7 @@ contract ChatNamespacedTest is MudTest {
     bytes32[] memory keyTuple;
     string memory value = "test";
     vm.expectEmit(true, true, true, true);
-    emit StoreCore.StoreSetRecord(
+    emit StoreCore.Store_SetRecord(
       MessageTableTableId,
       keyTuple,
       new bytes(0),

diff --git a/packages/block-logs-stream/README.md b/packages/block-logs-stream/README.md
@@ -26,9 +26,10 @@ latestBlockNumber$
       publicClient,
       address,
       events: parseAbi([
-        "event StoreDeleteRecord(bytes32 tableId, bytes32[] keyTuple)",
-        "event StoreSetField(bytes32 tableId, bytes32[] keyTuple, uint8 schemaIndex, bytes data)",
-        "event StoreSetRecord(bytes32 tableId, bytes32[] keyTuple, bytes data)",
+        "event Store_SetRecord(bytes32 indexed tableId, bytes32[] keyTuple, bytes staticData, bytes32 encodedLengths, bytes dynamicData)",
+        "event Store_SpliceStaticData(bytes32 indexed tableId, bytes32[] keyTuple, uint48 start, uint40 deleteCount, bytes data)",
+        "event Store_SpliceDynamicData(bytes32 indexed tableId, bytes32[] keyTuple, uint48 start, uint40 deleteCount, bytes data, bytes32 encodedLengths)",
+        "event Store_DeleteRecord(bytes32 indexed tableId, bytes32[] keyTuple)",
       ]),
     }),
     mergeMap(({ logs }) => from(groupLogsByBlockNumber(logs)))

diff --git a/packages/dev-tools/src/actions/WriteSummary.tsx b/packages/dev-tools/src/actions/WriteSummary.tsx
@@ -153,9 +153,11 @@ export function WriteSummary({ write }: Props) {
                       {table.namespace}:{table.name}
                     </td>
                     <td className="whitespace-nowrap">
-                      {eventName === "StoreSetRecord" ? <span className="text-green-500 font-bold">=</span> : null}
-                      {eventName === "StoreSetField" ? <span className="text-green-500 font-bold">+</span> : null}
-                      {eventName === "StoreDeleteRecord" ? <span className="text-red-500 font-bold">-</span> : null}
+                      {eventName === "Store_SetRecord" ? <span className="text-green-500 font-bold">=</span> : null}
+                      {eventName === "Store_SpliceStaticData" || eventName === "Store_SpliceDynamicData" ? (
+                        <span className="text-green-500 font-bold">+</span>
+                      ) : null}
+                      {eventName === "Store_DeleteRecord" ? <span className="text-red-500 font-bold">-</span> : null}
                     </td>
                     <td className="whitespace-nowrap overflow-hidden text-ellipsis">
                       {hexKeyTupleToEntity((args as any).keyTuple)}

diff --git a/packages/dev-tools/src/events/EventIcon.tsx b/packages/dev-tools/src/events/EventIcon.tsx
@@ -7,12 +7,12 @@ type Props = {
 
 export function EventIcon({ type }: Props) {
   switch (type) {
-    case "StoreSetRecord":
+    case "Store_SetRecord":
       return <span className="text-green-500 font-bold">=</span>;
-    case "StoreSpliceStaticData":
-    case "StoreSpliceDynamicData":
+    case "Store_SpliceStaticData":
+    case "Store_SpliceDynamicData":
       return <span className="text-cyan-500 font-bold">+</span>;
-    case "StoreDeleteRecord":
+    case "Store_DeleteRecord":
       return <span className="text-red-500 font-bold">-</span>;
     default:
       return assertExhaustive(type, `Unexpected event type: ${type}`);

diff --git a/packages/dev-tools/src/events/LogsTable.tsx b/packages/dev-tools/src/events/LogsTable.tsx
@@ -44,17 +44,17 @@ export function LogsTable({ logs }: Props) {
               </td>
               <td className="px-1 whitespace-nowrap overflow-hidden text-ellipsis">
                 {/* TODO: decode these values if we can */}
-                {log.eventName === "StoreSetRecord"
+                {log.eventName === "Store_SetRecord"
                   ? JSON.stringify({
                       staticData: log.args.staticData,
                       encodedLengths: log.args.encodedLengths,
                       dynamicData: log.args.dynamicData,
                     })
                   : null}
-                {log.eventName === "StoreSpliceStaticData"
+                {log.eventName === "Store_SpliceStaticData"
                   ? JSON.stringify({ start: log.args.start, deleteCount: log.args.deleteCount, data: log.args.data })
                   : null}
-                {log.eventName === "StoreSpliceDynamicData"
+                {log.eventName === "Store_SpliceDynamicData"
                   ? JSON.stringify({
                       start: log.args.start,
                       deleteCount: log.args.deleteCount,

diff --git a/packages/store-sync/src/createStoreSync.ts b/packages/store-sync/src/createStoreSync.ts
@@ -133,7 +133,7 @@ export async function createStoreSync<TConfig extends StoreConfig = StoreConfig>
       const logs: StorageAdapterLog[] = tables.flatMap((table) =>
         table.records.map(
           (record): StorageAdapterLog => ({
-            eventName: "StoreSetRecord",
+            eventName: "Store_SetRecord",
             address: table.address,
             args: {
               tableId: table.tableId,

diff --git a/packages/store-sync/src/isTableRegistrationLog.ts b/packages/store-sync/src/isTableRegistrationLog.ts
@@ -2,6 +2,6 @@ import { StorageAdapterLog, schemasTableId } from "./common";
 
 export function isTableRegistrationLog(
   log: StorageAdapterLog
-): log is StorageAdapterLog & { eventName: "StoreSetRecord" } {
-  return log.eventName === "StoreSetRecord" && log.args.tableId === schemasTableId;
+): log is StorageAdapterLog & { eventName: "Store_SetRecord" } {
+  return log.eventName === "Store_SetRecord" && log.args.tableId === schemasTableId;
 }
diff --git a/packages/store-sync/src/logToTable.test.ts b/packages/store-sync/src/logToTable.test.ts
@@ -6,7 +6,7 @@ describe("logToTable", () => {
     expect(
       logToTable({
         address: "0x3Aa5ebB10DC797CAC828524e59A333d0A371443c",
-        eventName: "StoreSetRecord",
+        eventName: "Store_SetRecord",
         args: {
           tableId: "0x74626d756473746f72650000000000005461626c657300000000000000000000",
           keyTuple: ["0x74626d756473746f72650000000000005461626c657300000000000000000000"],

diff --git a/packages/store-sync/src/logToTable.ts b/packages/store-sync/src/logToTable.ts
@@ -5,7 +5,7 @@ import { hexToResourceId } from "@latticexyz/common";
 
 // TODO: add tableToLog
 
-export function logToTable(log: StorageAdapterLog & { eventName: "StoreSetRecord" }): Table {
+export function logToTable(log: StorageAdapterLog & { eventName: "Store_SetRecord" }): Table {
   const [tableId, ...otherKeys] = log.args.keyTuple;
   if (otherKeys.length) {
     console.warn("registerSchema event is expected to have only one key in key tuple, but got multiple", log);

diff --git a/packages/store-sync/src/postgres/postgresStorage.test.ts b/packages/store-sync/src/postgres/postgresStorage.test.ts
@@ -56,7 +56,7 @@ describe("postgresStorage", async () => {
         {
           "chainId": 31337,
           "lastError": null,
-          "lastUpdatedBlockNumber": 5n,
+          "lastUpdatedBlockNumber": 6n,
           "schemaVersion": 1,
         },
       ]
@@ -74,7 +74,7 @@ describe("postgresStorage", async () => {
           "key": "0x5FbDB2315678afecb367f032d93F642f64180aa3::NumberList",
           "keySchema": {},
           "lastError": null,
-          "lastUpdatedBlockNumber": 5n,
+          "lastUpdatedBlockNumber": 6n,
           "name": "NumberList",
           "namespace": "",
           "schemaVersion": 1,
@@ -94,7 +94,7 @@ describe("postgresStorage", async () => {
           "key": "0x5FbDB2315678afecb367f032d93F642f64180aa3::NumberList",
           "keySchema": {},
           "lastError": null,
-          "lastUpdatedBlockNumber": 5n,
+          "lastUpdatedBlockNumber": 6n,
           "name": "NumberList",
           "namespace": "",
           "schemaVersion": 1,
@@ -114,7 +114,7 @@ describe("postgresStorage", async () => {
           "__encodedLengths": "0x0000000000000000000000000000000000000000000000000800000000000008",
           "__isDeleted": false,
           "__key": "0x",
-          "__lastUpdatedBlockNumber": 5n,
+          "__lastUpdatedBlockNumber": 6n,
           "__staticData": null,
           "value": [
             420,

diff --git a/packages/store-sync/src/postgres/postgresStorage.ts b/packages/store-sync/src/postgres/postgresStorage.ts
@@ -96,7 +96,7 @@ export async function postgresStorage<TConfig extends StoreConfig = StoreConfig>
 
         debug(log.eventName, log);
 
-        if (log.eventName === "StoreSetRecord") {
+        if (log.eventName === "Store_SetRecord") {
           const value = decodeValueArgs(table.valueSchema, log.args);
           debug("upserting record", {
             namespace: table.namespace,
@@ -128,7 +128,7 @@ export async function postgresStorage<TConfig extends StoreConfig = StoreConfig>
               },
             })
             .execute();
-        } else if (log.eventName === "StoreSpliceStaticData") {
+        } else if (log.eventName === "Store_SpliceStaticData") {
           // TODO: verify that this returns what we expect (doesn't error/undefined on no record)
           const previousValue = (await tx.select().from(sqlTable).where(eq(sqlTable.__key, uniqueKey)).execute())[0];
           const previousStaticData = (previousValue?.__staticData as Hex) ?? "0x";
@@ -167,7 +167,7 @@ export async function postgresStorage<TConfig extends StoreConfig = StoreConfig>
               },
             })
             .execute();
-        } else if (log.eventName === "StoreSpliceDynamicData") {
+        } else if (log.eventName === "Store_SpliceDynamicData") {
           // TODO: verify that this returns what we expect (doesn't error/undefined on no record)
           const previousValue = (await tx.select().from(sqlTable).where(eq(sqlTable.__key, uniqueKey)).execute())[0];
           const previousDynamicData = (previousValue?.__dynamicData as Hex) ?? "0x";
@@ -211,7 +211,7 @@ export async function postgresStorage<TConfig extends StoreConfig = StoreConfig>
               },
             })
             .execute();
-        } else if (log.eventName === "StoreDeleteRecord") {
+        } else if (log.eventName === "Store_DeleteRecord") {
           // TODO: should we upsert so we at least have a DB record of when a thing was created/deleted within the same block?
           debug("deleting record", {
             namespace: table.namespace,

diff --git a/packages/store-sync/src/recs/recsStorage.ts b/packages/store-sync/src/recs/recsStorage.ts
@@ -80,7 +80,7 @@ export function recsStorage<TConfig extends StoreConfig = StoreConfig>({
 
       const entity = hexKeyTupleToEntity(log.args.keyTuple);
 
-      if (log.eventName === "StoreSetRecord") {
+      if (log.eventName === "Store_SetRecord") {
         const value = decodeValueArgs(table.valueSchema, log.args);
         debug("setting component", {
           namespace: table.namespace,
@@ -94,7 +94,7 @@ export function recsStorage<TConfig extends StoreConfig = StoreConfig>({
           __encodedLengths: log.args.encodedLengths,
           __dynamicData: log.args.dynamicData,
         });
-      } else if (log.eventName === "StoreSpliceStaticData") {
+      } else if (log.eventName === "Store_SpliceStaticData") {
         // TODO: add tests that this works when no record had been set before
         const previousValue = getComponentValue(component, entity);
         const previousStaticData = (previousValue?.__staticData as Hex) ?? "0x";
@@ -117,7 +117,7 @@ export function recsStorage<TConfig extends StoreConfig = StoreConfig>({
           ...newValue,
           __staticData: newStaticData,
         });
-      } else if (log.eventName === "StoreSpliceDynamicData") {
+      } else if (log.eventName === "Store_SpliceDynamicData") {
         // TODO: add tests that this works when no record had been set before
         const previousValue = getComponentValue(component, entity);
         const previousDynamicData = (previousValue?.__dynamicData as Hex) ?? "0x";
@@ -142,7 +142,7 @@ export function recsStorage<TConfig extends StoreConfig = StoreConfig>({
           __encodedLengths: log.args.encodedLengths,
           __dynamicData: newDynamicData,
         });
-      } else if (log.eventName === "StoreDeleteRecord") {
+      } else if (log.eventName === "Store_DeleteRecord") {
         debug("deleting component", {
           namespace: table.namespace,
           name: table.name,

diff --git a/packages/store-sync/src/sqlite/sqliteStorage.test.ts b/packages/store-sync/src/sqlite/sqliteStorage.test.ts
@@ -64,7 +64,7 @@ describe("sqliteStorage", async () => {
         {
           "chainId": 31337,
           "lastError": null,
-          "lastUpdatedBlockNumber": 5n,
+          "lastUpdatedBlockNumber": 6n,
           "schemaVersion": 1,
         },
       ]
@@ -77,7 +77,7 @@ describe("sqliteStorage", async () => {
           "id": "0x5FbDB2315678afecb367f032d93F642f64180aa3____NumberList",
           "keySchema": {},
           "lastError": null,
-          "lastUpdatedBlockNumber": 5n,
+          "lastUpdatedBlockNumber": 6n,
           "name": "NumberList",
           "namespace": "",
           "schemaVersion": 1,
@@ -97,7 +97,7 @@ describe("sqliteStorage", async () => {
           "id": "0x5FbDB2315678afecb367f032d93F642f64180aa3____NumberList",
           "keySchema": {},
           "lastError": null,
-          "lastUpdatedBlockNumber": 5n,
+          "lastUpdatedBlockNumber": 6n,
           "name": "NumberList",
           "namespace": "",
           "schemaVersion": 1,
@@ -117,7 +117,7 @@ describe("sqliteStorage", async () => {
           "__encodedLengths": "0x0000000000000000000000000000000000000000000000000800000000000008",
           "__isDeleted": false,
           "__key": "0x",
-          "__lastUpdatedBlockNumber": 5n,
+          "__lastUpdatedBlockNumber": 6n,
           "__staticData": null,
           "value": [
             420,

diff --git a/packages/store-sync/src/sqlite/sqliteStorage.ts b/packages/store-sync/src/sqlite/sqliteStorage.ts
@@ -96,7 +96,7 @@ export async function sqliteStorage<TConfig extends StoreConfig = StoreConfig>({
         const uniqueKey = concatHex(log.args.keyTuple as Hex[]);
         const key = decodeKey(table.keySchema, log.args.keyTuple);
 
-        if (log.eventName === "StoreSetRecord") {
+        if (log.eventName === "Store_SetRecord") {
           const value = decodeValueArgs(table.valueSchema, log.args);
           debug("upserting record", {
             namespace: table.namespace,
@@ -127,7 +127,7 @@ export async function sqliteStorage<TConfig extends StoreConfig = StoreConfig>({
               },
             })
             .run();
-        } else if (log.eventName === "StoreSpliceStaticData") {
+        } else if (log.eventName === "Store_SpliceStaticData") {
           // TODO: verify that this returns what we expect (doesn't error/undefined on no record)
           const previousValue = (await tx.select().from(sqlTable).where(eq(sqlTable.__key, uniqueKey)).execute())[0];
           const previousStaticData = (previousValue?.__staticData as Hex) ?? "0x";
@@ -165,7 +165,7 @@ export async function sqliteStorage<TConfig extends StoreConfig = StoreConfig>({
               },
             })
             .run();
-        } else if (log.eventName === "StoreSpliceDynamicData") {
+        } else if (log.eventName === "Store_SpliceDynamicData") {
           const previousValue = (await tx.select().from(sqlTable).where(eq(sqlTable.__key, uniqueKey)).execute())[0];
           const previousDynamicData = (previousValue?.__dynamicData as Hex) ?? "0x";
           const newDynamicData = spliceHex(previousDynamicData, log.args.start, log.args.deleteCount, log.args.data);
@@ -207,7 +207,7 @@ export async function sqliteStorage<TConfig extends StoreConfig = StoreConfig>({
               },
             })
             .run();
-        } else if (log.eventName === "StoreDeleteRecord") {
+        } else if (log.eventName === "Store_DeleteRecord") {
           // TODO: should we upsert so we at least have a DB record of when a thing was created/deleted within the same block?
           debug("deleting record", {
             namespace: table.namespace,

diff --git a/packages/store/src/IStore.sol b/packages/store/src/IStore.sol
@@ -85,29 +85,29 @@ interface IStoreRead {
 }
 
 interface IStoreWrite {
-  event StoreSetRecord(
+  event Store_SetRecord(
     ResourceId indexed tableId,
     bytes32[] keyTuple,
     bytes staticData,
     bytes32 encodedLengths,
     bytes dynamicData
   );
-  event StoreSpliceStaticData(
+  event Store_SpliceStaticData(
     ResourceId indexed tableId,
     bytes32[] keyTuple,
     uint48 start,
     uint40 deleteCount,
     bytes data
   );
-  event StoreSpliceDynamicData(
+  event Store_SpliceDynamicData(
     ResourceId indexed tableId,
     bytes32[] keyTuple,
     uint48 start,
     uint40 deleteCount,
     bytes data,
     bytes32 encodedLengths
   );
-  event StoreDeleteRecord(ResourceId indexed tableId, bytes32[] keyTuple);
+  event Store_DeleteRecord(ResourceId indexed tableId, bytes32[] keyTuple);
 
   // Set full record (including full dynamic data)
   function setRecord(