refactor(store): hellostore in IStoreEvents (#2357)

latticexyz · Mar 4, 2024 · c58da9a · c58da9a
1 parent 2c920de
commit c58da9a
Show file tree

Hide file tree

Showing 6 changed files with 29 additions and 26 deletions.
diff --git a/.changeset/spicy-waves-wait.md b/.changeset/spicy-waves-wait.md
@@ -0,0 +1,5 @@
+---
+"@latticexyz/store": patch
+---
+
+Moved the `HelloStore` to `IStoreEvents` so all Store events are defined in the same interface.
diff --git a/docs/pages/store/reference/store.mdx b/docs/pages/store/reference/store.mdx
@@ -15,6 +15,20 @@ IStore implements the error interfaces for each library that it uses.
 
 ### Events
 
+#### HelloStore
+
+Emitted when the store is initialized.
+
+```solidity
+event HelloStore(bytes32 indexed storeVersion);
+```
+
+**Parameters**
+
+| Name           | Type      | Description                        |
+| -------------- | --------- | ---------------------------------- |
+| `storeVersion` | `bytes32` | The version of the Store contract. |
+
 #### Store_SetRecord
 
 Emitted when a new record is set in the store.
@@ -212,22 +226,6 @@ function storeVersion() external view returns (bytes32 version);
 | --------- | --------- | ---------------------------------- |
 | `version` | `bytes32` | The version of the Store contract. |
 
-### Events
-
-#### HelloStore
-
-Emitted when the store is initialized.
-
-```solidity
-event HelloStore(bytes32 indexed storeVersion);
-```
-
-**Parameters**
-
-| Name           | Type      | Description                        |
-| -------------- | --------- | ---------------------------------- |
-| `storeVersion` | `bytes32` | The version of the Store contract. |
-
 ## IStoreRead
 
 [Git Source](https://github.com/latticexyz/mud/blob/main/packages/store/src/IStoreRead.sol)

diff --git a/packages/store/src/IStoreData.sol b/packages/store/src/IStoreData.sol
@@ -11,12 +11,6 @@ import { IStoreWrite } from "./IStoreWrite.sol";
  * @dev These methods are frequently invoked during runtime, so it is essential to prioritize optimizing their gas cost.
  */
 interface IStoreData is IStoreRead, IStoreWrite {
-  /**
-   * @notice Emitted when the store is initialized.
-   * @param storeVersion The version of the Store contract.
-   */
-  event HelloStore(bytes32 indexed storeVersion);
-
   /**
    * @notice Returns the version of the Store contract.
    * @return version The version of the Store contract.

diff --git a/packages/store/src/IStoreEvents.sol b/packages/store/src/IStoreEvents.sol
@@ -9,6 +9,12 @@ import { PackedCounter } from "./PackedCounter.sol";
  * @author MUD (https://mud.dev) by Lattice (https://lattice.xyz)
  */
 interface IStoreEvents {
+  /**
+   * @notice Emitted when the store is initialized.
+   * @param storeVersion The version of the Store contract.
+   */
+  event HelloStore(bytes32 indexed storeVersion);
+
   /**
    * @notice Emitted when a new record is set in the store.
    * @param tableId The ID of the table where the record is set.

diff --git a/packages/store/src/StoreData.sol b/packages/store/src/StoreData.sol
@@ -5,6 +5,7 @@ import { STORE_VERSION } from "./version.sol";
 import { IStoreData } from "./IStoreData.sol";
 import { StoreRead } from "./StoreRead.sol";
 import { StoreCore } from "./StoreCore.sol";
+import { IStoreEvents } from "./IStoreEvents.sol";
 
 /**
  * @title Store Data Contract
@@ -20,7 +21,7 @@ abstract contract StoreData is IStoreData, StoreRead {
    */
   constructor() {
     StoreCore.initialize();
-    emit HelloStore(STORE_VERSION);
+    emit IStoreEvents.HelloStore(STORE_VERSION);
   }
 
   /**

diff --git a/packages/store/test/StoreMock.t.sol b/packages/store/test/StoreMock.t.sol
@@ -7,13 +7,12 @@ import { STORE_VERSION } from "../src/version.sol";
 import { StoreCore } from "../src/StoreCore.sol";
 import { StoreMock } from "../test/StoreMock.sol";
 import { StoreSwitch } from "../src/StoreSwitch.sol";
+import { IStoreEvents } from "../src/IStoreEvents.sol";
 
 contract StoreMockTest is Test {
-  event HelloStore(bytes32 indexed storeVersion);
-
   function testStoreMockConstrctor() public {
     vm.expectEmit(true, true, true, true);
-    emit HelloStore(STORE_VERSION);
+    emit IStoreEvents.HelloStore(STORE_VERSION);
     new StoreMock();
   }
 }