refactor(store): add StoreWrite and Store abstract contracts

.changeset/silly-mirrors-marry.md

@@ -0,0 +1,6 @@
+---
+"@latticexyz/store": minor
+"@latticexyz/world": patch
+---
+
+Added an `abstract` `StoreWrite` contract, and renamed `StoreData` to `Store`.

docs/pages/store/reference/store-core.mdx

@@ -1015,23 +1015,24 @@ function _loadEncodedDynamicDataLength(
 | -------- | --------------- | ----------------------------------------------------------------------------------------- |
 | `<none>` | `PackedCounter` | The loaded encoded dynamic data length from storage for the given table ID and key tuple. |
 
-## StoreData
+## Store
 
-[Git Source](https://github.com/latticexyz/mud/blob/main/packages/store/src/StoreData.sol)
+[Git Source](https://github.com/latticexyz/mud/blob/main/packages/store/src/Store.sol)
 
 **Inherits:**
-[IStoreData](/store/reference/store#istoredata), [StoreRead](/store/reference/store-core#storeread)
+[StoreWrite](/src/StoreWrite.sol/abstract.StoreWrite.md), [StoreRead](/store/reference/store-core#storeread)
 
 This contract integrates the core storage functionalities and provides an interface for data storage.
 
 _This abstract contract initializes `StoreCore`, implements `storeVersion`, and read methods,
-but not write methods._
+but not write methods.
+Note that `Store` does not implement `IStore`, because we want `IWorldKernel` to inherit `IStore` but it does not implement all the Store methods._
 
 ### Functions
 
 #### constructor
 
-Constructs the StoreData contract and initializes the StoreCore.
+Constructs the Store contract and initializes the StoreCore.
 
 _Emits a HelloStore event upon creation._
 

docs/pages/store/reference/store.mdx

@@ -5,10 +5,26 @@
 [Git Source](https://github.com/latticexyz/mud/blob/main/packages/store/src/IStore.sol)
 
 **Inherits:**
-[IStoreData](/store/reference/store#istoredata), [IStoreRegistration](/store/reference/store#istoreregistration), [IStoreErrors](/store/reference/store#istoreerrors), [IFieldLayoutErrors](/src/IFieldLayoutErrors.sol/interface.IFieldLayoutErrors.md), [IPackedCounterErrors](/src/IPackedCounterErrors.sol/interface.IPackedCounterErrors.md), [ISchemaErrors](/src/ISchemaErrors.sol/interface.ISchemaErrors.md), [ISliceErrors](/src/ISliceErrors.sol/interface.ISliceErrors.md)
+[IStoreRead](/store/reference/store#istoreread), [IStoreWrite](/store/reference/store#istorewrite), [IStoreRegistration](/store/reference/store#istoreregistration), [IStoreErrors](/store/reference/store#istoreerrors), [IFieldLayoutErrors](/src/IFieldLayoutErrors.sol/interface.IFieldLayoutErrors.md), [IPackedCounterErrors](/src/IPackedCounterErrors.sol/interface.IPackedCounterErrors.md), [ISchemaErrors](/src/ISchemaErrors.sol/interface.ISchemaErrors.md), [ISliceErrors](/src/ISliceErrors.sol/interface.ISliceErrors.md)
 
 IStore implements the error interfaces for each library that it uses.
 
+### Functions
+
+#### storeVersion
+
+Returns the version of the Store contract.
+
+```solidity
+function storeVersion() external view returns (bytes32 version);
+```
+
+**Returns**
+
+| Name      | Type      | Description                        |
+| --------- | --------- | ---------------------------------- |
+| `version` | `bytes32` | The version of the Store contract. |
+
 ## IStoreEvents
 
 [Git Source](https://github.com/latticexyz/mud/blob/main/packages/store/src/IStoreEvents.sol)
@@ -313,33 +329,6 @@ error Store_InvalidSplice(uint40 startWithinField, uint40 deleteCount, uint40 fi
 | `deleteCount`      | `uint40` | The number of bytes to delete in the splice operation.     |
 | `fieldLength`      | `uint40` | The field length for the splice operation.                 |
 
-## IStoreData
-
-[Git Source](https://github.com/latticexyz/mud/blob/main/packages/store/src/IStoreData.sol)
-
-**Inherits:**
-[IStoreRead](/store/reference/store#istoreread), [IStoreWrite](/store/reference/store#istorewrite)
-
-The IStoreData interface includes methods for reading and writing table values.
-
-_These methods are frequently invoked during runtime, so it is essential to prioritize optimizing their gas cost._
-
-### Functions
-
-#### storeVersion
-
-Returns the version of the Store contract.
-
-```solidity
-function storeVersion() external view returns (bytes32 version);
-```
-
-**Returns**
-
-| Name      | Type      | Description                        |
-| --------- | --------- | ---------------------------------- |
-| `version` | `bytes32` | The version of the Store contract. |
-
 ## IStoreRead
 
 [Git Source](https://github.com/latticexyz/mud/blob/main/packages/store/src/IStoreRead.sol)

docs/pages/world/reference/world-external.mdx

@@ -12,6 +12,19 @@ that are dynamically registered in the World during deployment.
 
 _._
 
+## Store
+
+[Git Source](https://github.com/latticexyz/mud/blob/main/packages/world/src/Store.sol)
+
+**Inherits:**
+[StoreWrite](/src/StoreWrite.sol/abstract.StoreWrite.md), [StoreRead](/store/reference/store-core#storeread)
+
+This contract integrates the core storage functionalities and provides an interface for data storage.
+
+_This abstract contract initializes `StoreCore`, implements `storeVersion`, and read methods,
+but not write methods.
+Note that `Store` does not implement `IStore`, because we want `IWorldKernel` to inherit `IStore` but it does not implement all the Store methods._
+
 ### Functions
 
 #### storeVersion

docs/pages/world/reference/world.mdx

@@ -5,7 +5,7 @@
 [Git Source](https://github.com/latticexyz/mud/blob/main/packages/world/src/World.sol)
 
 **Inherits:**
-[StoreData](/store/reference/store-core#storedata), [IWorldKernel](/world/reference/world-external#iworldkernel)
+Store, [IWorldKernel](/world/reference/world-external#iworldkernel)
 
 _This contract is the core "World" contract containing various methods for
 data manipulation, system calls, and dynamic function selector handling._

packages/store/src/IStore.sol

@@ -1,8 +1,9 @@
 // SPDX-License-Identifier: MIT
 pragma solidity >=0.8.24;
 
+import { IStoreRead } from "./IStoreRead.sol";
+import { IStoreWrite } from "./IStoreWrite.sol";
 import { IStoreErrors } from "./IStoreErrors.sol";
-import { IStoreData } from "./IStoreData.sol";
 import { IStoreRegistration } from "./IStoreRegistration.sol";
 import { IFieldLayoutErrors } from "./IFieldLayoutErrors.sol";
 import { IPackedCounterErrors } from "./IPackedCounterErrors.sol";
@@ -15,11 +16,18 @@ import { ISliceErrors } from "./ISliceErrors.sol";
  * @notice IStore implements the error interfaces for each library that it uses.
  */
 interface IStore is
-  IStoreData,
+  IStoreRead,
+  IStoreWrite,
   IStoreRegistration,
   IStoreErrors,
   IFieldLayoutErrors,
   IPackedCounterErrors,
   ISchemaErrors,
   ISliceErrors
-{}
+{
+  /**
+   * @notice Returns the version of the Store contract.
+   * @return version The version of the Store contract.
+   */
+  function storeVersion() external view returns (bytes32 version);
+}

packages/store/src/StoreData.sol → packages/store/src/Store.sol

@@ -2,21 +2,22 @@
 pragma solidity >=0.8.24;
 
 import { STORE_VERSION } from "./version.sol";
-import { IStoreData } from "./IStoreData.sol";
+import { StoreWrite } from "./StoreWrite.sol";
 import { StoreRead } from "./StoreRead.sol";
 import { StoreCore } from "./StoreCore.sol";
 import { IStoreEvents } from "./IStoreEvents.sol";
 
 /**
- * @title Store Data Contract
+ * @title Store Contract
  * @author MUD (https://mud.dev) by Lattice (https://lattice.xyz)
  * @notice This contract integrates the core storage functionalities and provides an interface for data storage.
  * @dev This abstract contract initializes `StoreCore`, implements `storeVersion`, and read methods,
  * but not write methods.
+ * Note that `Store` does not implement `IStore`, because we want `IWorldKernel` to inherit `IStore` but it does not implement all the Store methods.
  */
-abstract contract StoreData is IStoreData, StoreRead {
+abstract contract Store is StoreWrite, StoreRead {
   /**
-   * @notice Constructs the StoreData contract and initializes the StoreCore.
+   * @notice Constructs the Store contract and initializes the StoreCore.
    * @dev Emits a HelloStore event upon creation.
    */
   constructor() {

packages/store/src/StoreWrite.sol

@@ -0,0 +1,10 @@
+// SPDX-License-Identifier: MIT
+pragma solidity >=0.8.24;
+
+import { IStoreWrite } from "./IStoreWrite.sol";
+
+/**
+ * @title StoreWrite
+ * @author MUD (https://mud.dev) by Lattice (https://lattice.xyz)
+ */
+abstract contract StoreWrite is IStoreWrite {}