@latticexyz/world-modules 2.0.12-type-resolutions-effc7ab1 → 2.0.12-type-resolutions-ad8cc987

package/src/modules/keysintable/tables/UsedKeysIndex.sol

@@ -0,0 +1,414 @@
+// SPDX-License-Identifier: MIT
+pragma solidity >=0.8.24;
+
+/* Autogenerated file. Do not edit manually. */
+
+// Import store internals
+import { IStore } from "@latticexyz/store/src/IStore.sol";
+import { StoreSwitch } from "@latticexyz/store/src/StoreSwitch.sol";
+import { StoreCore } from "@latticexyz/store/src/StoreCore.sol";
+import { Bytes } from "@latticexyz/store/src/Bytes.sol";
+import { Memory } from "@latticexyz/store/src/Memory.sol";
+import { SliceLib } from "@latticexyz/store/src/Slice.sol";
+import { EncodeArray } from "@latticexyz/store/src/tightcoder/EncodeArray.sol";
+import { FieldLayout } from "@latticexyz/store/src/FieldLayout.sol";
+import { Schema } from "@latticexyz/store/src/Schema.sol";
+import { EncodedLengths, EncodedLengthsLib } from "@latticexyz/store/src/EncodedLengths.sol";
+import { ResourceId } from "@latticexyz/store/src/ResourceId.sol";
+
+// Import user types
+import { ResourceId } from "@latticexyz/store/src/ResourceId.sol";
+
+library UsedKeysIndex {
+  // Hex below is the result of `WorldResourceIdLib.encode({ namespace: "", name: "UsedKeysIndex", typeId: RESOURCE_TABLE });`
+  ResourceId constant _tableId = ResourceId.wrap(0x74620000000000000000000000000000557365644b657973496e646578000000);
+
+  FieldLayout constant _fieldLayout =
+    FieldLayout.wrap(0x0006020001050000000000000000000000000000000000000000000000000000);
+
+  // Hex-encoded key schema of (bytes32, bytes32)
+  Schema constant _keySchema = Schema.wrap(0x004002005f5f0000000000000000000000000000000000000000000000000000);
+  // Hex-encoded value schema of (bool, uint40)
+  Schema constant _valueSchema = Schema.wrap(0x0006020060040000000000000000000000000000000000000000000000000000);
+
+  /**
+   * @notice Get the table's key field names.
+   * @return keyNames An array of strings with the names of key fields.
+   */
+  function getKeyNames() internal pure returns (string[] memory keyNames) {
+    keyNames = new string[](2);
+    keyNames[0] = "sourceTableId";
+    keyNames[1] = "keysHash";
+  }
+
+  /**
+   * @notice Get the table's value field names.
+   * @return fieldNames An array of strings with the names of value fields.
+   */
+  function getFieldNames() internal pure returns (string[] memory fieldNames) {
+    fieldNames = new string[](2);
+    fieldNames[0] = "has";
+    fieldNames[1] = "index";
+  }
+
+  /**
+   * @notice Register the table with its config.
+   */
+  function register() internal {
+    StoreSwitch.registerTable(_tableId, _fieldLayout, _keySchema, _valueSchema, getKeyNames(), getFieldNames());
+  }
+
+  /**
+   * @notice Register the table with its config.
+   */
+  function _register() internal {
+    StoreCore.registerTable(_tableId, _fieldLayout, _keySchema, _valueSchema, getKeyNames(), getFieldNames());
+  }
+
+  /**
+   * @notice Register the table with its config (using the specified store).
+   */
+  function register(IStore _store) internal {
+    _store.registerTable(_tableId, _fieldLayout, _keySchema, _valueSchema, getKeyNames(), getFieldNames());
+  }
+
+  /**
+   * @notice Get has.
+   */
+  function getHas(ResourceId sourceTableId, bytes32 keysHash) internal view returns (bool has) {
+    bytes32[] memory _keyTuple = new bytes32[](2);
+    _keyTuple[0] = ResourceId.unwrap(sourceTableId);
+    _keyTuple[1] = keysHash;
+
+    bytes32 _blob = StoreSwitch.getStaticField(_tableId, _keyTuple, 0, _fieldLayout);
+    return (_toBool(uint8(bytes1(_blob))));
+  }
+
+  /**
+   * @notice Get has.
+   */
+  function _getHas(ResourceId sourceTableId, bytes32 keysHash) internal view returns (bool has) {
+    bytes32[] memory _keyTuple = new bytes32[](2);
+    _keyTuple[0] = ResourceId.unwrap(sourceTableId);
+    _keyTuple[1] = keysHash;
+
+    bytes32 _blob = StoreCore.getStaticField(_tableId, _keyTuple, 0, _fieldLayout);
+    return (_toBool(uint8(bytes1(_blob))));
+  }
+
+  /**
+   * @notice Get has (using the specified store).
+   */
+  function getHas(IStore _store, ResourceId sourceTableId, bytes32 keysHash) internal view returns (bool has) {
+    bytes32[] memory _keyTuple = new bytes32[](2);
+    _keyTuple[0] = ResourceId.unwrap(sourceTableId);
+    _keyTuple[1] = keysHash;
+
+    bytes32 _blob = _store.getStaticField(_tableId, _keyTuple, 0, _fieldLayout);
+    return (_toBool(uint8(bytes1(_blob))));
+  }
+
+  /**
+   * @notice Set has.
+   */
+  function setHas(ResourceId sourceTableId, bytes32 keysHash, bool has) internal {
+    bytes32[] memory _keyTuple = new bytes32[](2);
+    _keyTuple[0] = ResourceId.unwrap(sourceTableId);
+    _keyTuple[1] = keysHash;
+
+    StoreSwitch.setStaticField(_tableId, _keyTuple, 0, abi.encodePacked((has)), _fieldLayout);
+  }
+
+  /**
+   * @notice Set has.
+   */
+  function _setHas(ResourceId sourceTableId, bytes32 keysHash, bool has) internal {
+    bytes32[] memory _keyTuple = new bytes32[](2);
+    _keyTuple[0] = ResourceId.unwrap(sourceTableId);
+    _keyTuple[1] = keysHash;
+
+    StoreCore.setStaticField(_tableId, _keyTuple, 0, abi.encodePacked((has)), _fieldLayout);
+  }
+
+  /**
+   * @notice Set has (using the specified store).
+   */
+  function setHas(IStore _store, ResourceId sourceTableId, bytes32 keysHash, bool has) internal {
+    bytes32[] memory _keyTuple = new bytes32[](2);
+    _keyTuple[0] = ResourceId.unwrap(sourceTableId);
+    _keyTuple[1] = keysHash;
+
+    _store.setStaticField(_tableId, _keyTuple, 0, abi.encodePacked((has)), _fieldLayout);
+  }
+
+  /**
+   * @notice Get index.
+   */
+  function getIndex(ResourceId sourceTableId, bytes32 keysHash) internal view returns (uint40 index) {
+    bytes32[] memory _keyTuple = new bytes32[](2);
+    _keyTuple[0] = ResourceId.unwrap(sourceTableId);
+    _keyTuple[1] = keysHash;
+
+    bytes32 _blob = StoreSwitch.getStaticField(_tableId, _keyTuple, 1, _fieldLayout);
+    return (uint40(bytes5(_blob)));
+  }
+
+  /**
+   * @notice Get index.
+   */
+  function _getIndex(ResourceId sourceTableId, bytes32 keysHash) internal view returns (uint40 index) {
+    bytes32[] memory _keyTuple = new bytes32[](2);
+    _keyTuple[0] = ResourceId.unwrap(sourceTableId);
+    _keyTuple[1] = keysHash;
+
+    bytes32 _blob = StoreCore.getStaticField(_tableId, _keyTuple, 1, _fieldLayout);
+    return (uint40(bytes5(_blob)));
+  }
+
+  /**
+   * @notice Get index (using the specified store).
+   */
+  function getIndex(IStore _store, ResourceId sourceTableId, bytes32 keysHash) internal view returns (uint40 index) {
+    bytes32[] memory _keyTuple = new bytes32[](2);
+    _keyTuple[0] = ResourceId.unwrap(sourceTableId);
+    _keyTuple[1] = keysHash;
+
+    bytes32 _blob = _store.getStaticField(_tableId, _keyTuple, 1, _fieldLayout);
+    return (uint40(bytes5(_blob)));
+  }
+
+  /**
+   * @notice Set index.
+   */
+  function setIndex(ResourceId sourceTableId, bytes32 keysHash, uint40 index) internal {
+    bytes32[] memory _keyTuple = new bytes32[](2);
+    _keyTuple[0] = ResourceId.unwrap(sourceTableId);
+    _keyTuple[1] = keysHash;
+
+    StoreSwitch.setStaticField(_tableId, _keyTuple, 1, abi.encodePacked((index)), _fieldLayout);
+  }
+
+  /**
+   * @notice Set index.
+   */
+  function _setIndex(ResourceId sourceTableId, bytes32 keysHash, uint40 index) internal {
+    bytes32[] memory _keyTuple = new bytes32[](2);
+    _keyTuple[0] = ResourceId.unwrap(sourceTableId);
+    _keyTuple[1] = keysHash;
+
+    StoreCore.setStaticField(_tableId, _keyTuple, 1, abi.encodePacked((index)), _fieldLayout);
+  }
+
+  /**
+   * @notice Set index (using the specified store).
+   */
+  function setIndex(IStore _store, ResourceId sourceTableId, bytes32 keysHash, uint40 index) internal {
+    bytes32[] memory _keyTuple = new bytes32[](2);
+    _keyTuple[0] = ResourceId.unwrap(sourceTableId);
+    _keyTuple[1] = keysHash;
+
+    _store.setStaticField(_tableId, _keyTuple, 1, abi.encodePacked((index)), _fieldLayout);
+  }
+
+  /**
+   * @notice Get the full data.
+   */
+  function get(ResourceId sourceTableId, bytes32 keysHash) internal view returns (bool has, uint40 index) {
+    bytes32[] memory _keyTuple = new bytes32[](2);
+    _keyTuple[0] = ResourceId.unwrap(sourceTableId);
+    _keyTuple[1] = keysHash;
+
+    (bytes memory _staticData, EncodedLengths _encodedLengths, bytes memory _dynamicData) = StoreSwitch.getRecord(
+      _tableId,
+      _keyTuple,
+      _fieldLayout
+    );
+    return decode(_staticData, _encodedLengths, _dynamicData);
+  }
+
+  /**
+   * @notice Get the full data.
+   */
+  function _get(ResourceId sourceTableId, bytes32 keysHash) internal view returns (bool has, uint40 index) {
+    bytes32[] memory _keyTuple = new bytes32[](2);
+    _keyTuple[0] = ResourceId.unwrap(sourceTableId);
+    _keyTuple[1] = keysHash;
+
+    (bytes memory _staticData, EncodedLengths _encodedLengths, bytes memory _dynamicData) = StoreCore.getRecord(
+      _tableId,
+      _keyTuple,
+      _fieldLayout
+    );
+    return decode(_staticData, _encodedLengths, _dynamicData);
+  }
+
+  /**
+   * @notice Get the full data (using the specified store).
+   */
+  function get(
+    IStore _store,
+    ResourceId sourceTableId,
+    bytes32 keysHash
+  ) internal view returns (bool has, uint40 index) {
+    bytes32[] memory _keyTuple = new bytes32[](2);
+    _keyTuple[0] = ResourceId.unwrap(sourceTableId);
+    _keyTuple[1] = keysHash;
+
+    (bytes memory _staticData, EncodedLengths _encodedLengths, bytes memory _dynamicData) = _store.getRecord(
+      _tableId,
+      _keyTuple,
+      _fieldLayout
+    );
+    return decode(_staticData, _encodedLengths, _dynamicData);
+  }
+
+  /**
+   * @notice Set the full data using individual values.
+   */
+  function set(ResourceId sourceTableId, bytes32 keysHash, bool has, uint40 index) internal {
+    bytes memory _staticData = encodeStatic(has, index);
+
+    EncodedLengths _encodedLengths;
+    bytes memory _dynamicData;
+
+    bytes32[] memory _keyTuple = new bytes32[](2);
+    _keyTuple[0] = ResourceId.unwrap(sourceTableId);
+    _keyTuple[1] = keysHash;
+
+    StoreSwitch.setRecord(_tableId, _keyTuple, _staticData, _encodedLengths, _dynamicData);
+  }
+
+  /**
+   * @notice Set the full data using individual values.
+   */
+  function _set(ResourceId sourceTableId, bytes32 keysHash, bool has, uint40 index) internal {
+    bytes memory _staticData = encodeStatic(has, index);
+
+    EncodedLengths _encodedLengths;
+    bytes memory _dynamicData;
+
+    bytes32[] memory _keyTuple = new bytes32[](2);
+    _keyTuple[0] = ResourceId.unwrap(sourceTableId);
+    _keyTuple[1] = keysHash;
+
+    StoreCore.setRecord(_tableId, _keyTuple, _staticData, _encodedLengths, _dynamicData, _fieldLayout);
+  }
+
+  /**
+   * @notice Set the full data using individual values (using the specified store).
+   */
+  function set(IStore _store, ResourceId sourceTableId, bytes32 keysHash, bool has, uint40 index) internal {
+    bytes memory _staticData = encodeStatic(has, index);
+
+    EncodedLengths _encodedLengths;
+    bytes memory _dynamicData;
+
+    bytes32[] memory _keyTuple = new bytes32[](2);
+    _keyTuple[0] = ResourceId.unwrap(sourceTableId);
+    _keyTuple[1] = keysHash;
+
+    _store.setRecord(_tableId, _keyTuple, _staticData, _encodedLengths, _dynamicData);
+  }
+
+  /**
+   * @notice Decode the tightly packed blob of static data using this table's field layout.
+   */
+  function decodeStatic(bytes memory _blob) internal pure returns (bool has, uint40 index) {
+    has = (_toBool(uint8(Bytes.getBytes1(_blob, 0))));
+
+    index = (uint40(Bytes.getBytes5(_blob, 1)));
+  }
+
+  /**
+   * @notice Decode the tightly packed blobs using this table's field layout.
+   * @param _staticData Tightly packed static fields.
+   *
+   *
+   */
+  function decode(
+    bytes memory _staticData,
+    EncodedLengths,
+    bytes memory
+  ) internal pure returns (bool has, uint40 index) {
+    (has, index) = decodeStatic(_staticData);
+  }
+
+  /**
+   * @notice Delete all data for given keys.
+   */
+  function deleteRecord(ResourceId sourceTableId, bytes32 keysHash) internal {
+    bytes32[] memory _keyTuple = new bytes32[](2);
+    _keyTuple[0] = ResourceId.unwrap(sourceTableId);
+    _keyTuple[1] = keysHash;
+
+    StoreSwitch.deleteRecord(_tableId, _keyTuple);
+  }
+
+  /**
+   * @notice Delete all data for given keys.
+   */
+  function _deleteRecord(ResourceId sourceTableId, bytes32 keysHash) internal {
+    bytes32[] memory _keyTuple = new bytes32[](2);
+    _keyTuple[0] = ResourceId.unwrap(sourceTableId);
+    _keyTuple[1] = keysHash;
+
+    StoreCore.deleteRecord(_tableId, _keyTuple, _fieldLayout);
+  }
+
+  /**
+   * @notice Delete all data for given keys (using the specified store).
+   */
+  function deleteRecord(IStore _store, ResourceId sourceTableId, bytes32 keysHash) internal {
+    bytes32[] memory _keyTuple = new bytes32[](2);
+    _keyTuple[0] = ResourceId.unwrap(sourceTableId);
+    _keyTuple[1] = keysHash;
+
+    _store.deleteRecord(_tableId, _keyTuple);
+  }
+
+  /**
+   * @notice Tightly pack static (fixed length) data using this table's schema.
+   * @return The static data, encoded into a sequence of bytes.
+   */
+  function encodeStatic(bool has, uint40 index) internal pure returns (bytes memory) {
+    return abi.encodePacked(has, index);
+  }
+
+  /**
+   * @notice Encode all of a record's fields.
+   * @return The static (fixed length) data, encoded into a sequence of bytes.
+   * @return The lengths of the dynamic fields (packed into a single bytes32 value).
+   * @return The dynamic (variable length) data, encoded into a sequence of bytes.
+   */
+  function encode(bool has, uint40 index) internal pure returns (bytes memory, EncodedLengths, bytes memory) {
+    bytes memory _staticData = encodeStatic(has, index);
+
+    EncodedLengths _encodedLengths;
+    bytes memory _dynamicData;
+
+    return (_staticData, _encodedLengths, _dynamicData);
+  }
+
+  /**
+   * @notice Encode keys as a bytes32 array using this table's field layout.
+   */
+  function encodeKeyTuple(ResourceId sourceTableId, bytes32 keysHash) internal pure returns (bytes32[] memory) {
+    bytes32[] memory _keyTuple = new bytes32[](2);
+    _keyTuple[0] = ResourceId.unwrap(sourceTableId);
+    _keyTuple[1] = keysHash;
+
+    return _keyTuple;
+  }
+}
+
+/**
+ * @notice Cast a value to a bool.
+ * @dev Boolean values are encoded as uint8 (1 = true, 0 = false), but Solidity doesn't allow casting between uint8 and bool.
+ * @param value The uint8 value to convert.
+ * @return result The boolean value.
+ */
+function _toBool(uint8 value) pure returns (bool result) {
+  assembly {
+    result := value
+  }
+}

package/src/modules/keyswithvalue/KeysWithValueHook.sol

@@ -0,0 +1,158 @@
+// SPDX-License-Identifier: MIT
+pragma solidity >=0.8.24;
+
+import { StoreHook } from "@latticexyz/store/src/StoreHook.sol";
+import { Bytes } from "@latticexyz/store/src/Bytes.sol";
+import { FieldLayout } from "@latticexyz/store/src/FieldLayout.sol";
+import { StoreSwitch } from "@latticexyz/store/src/StoreSwitch.sol";
+import { EncodedLengths } from "@latticexyz/store/src/EncodedLengths.sol";
+import { Tables } from "@latticexyz/store/src/codegen/tables/Tables.sol";
+import { IBaseWorld } from "@latticexyz/world/src/codegen/interfaces/IBaseWorld.sol";
+
+import { ResourceId, WorldResourceIdInstance } from "@latticexyz/world/src/WorldResourceId.sol";
+
+import { MODULE_NAMESPACE } from "./constants.sol";
+import { KeysWithValue } from "./tables/KeysWithValue.sol";
+import { ArrayLib } from "../utils/ArrayLib.sol";
+import { getTargetTableId } from "./getTargetTableId.sol";
+
+/**
+ * This is a very naive and inefficient implementation for now.
+ * We can optimize this by adding support for `setIndexOfField` in Store
+ * (See https://github.com/latticexyz/mud/issues/444)
+ *
+ * Note: if a table with composite keys is used, only the first key of the tuple is indexed
+ */
+contract KeysWithValueHook is StoreHook {
+  using ArrayLib for bytes32[];
+  using WorldResourceIdInstance for ResourceId;
+
+  function _world() internal view returns (IBaseWorld) {
+    return IBaseWorld(StoreSwitch.getStoreAddress());
+  }
+
+  function onBeforeSetRecord(
+    ResourceId sourceTableId,
+    bytes32[] memory keyTuple,
+    bytes memory staticData,
+    EncodedLengths encodedLengths,
+    bytes memory dynamicData,
+    FieldLayout fieldLayout
+  ) public override {
+    ResourceId targetTableId = getTargetTableId(MODULE_NAMESPACE, sourceTableId);
+
+    // Get the previous value
+    bytes32 previousValue = _getRecordValueHash(sourceTableId, keyTuple, fieldLayout);
+
+    // Remove the key from the list of keys with the previous value
+    _removeKeyFromList(targetTableId, keyTuple[0], previousValue);
+
+    // Push the key to the list of keys with the new value
+    bytes memory data;
+    if (dynamicData.length > 0) {
+      data = abi.encodePacked(staticData, encodedLengths, dynamicData);
+    } else {
+      data = staticData;
+    }
+    KeysWithValue.push(targetTableId, keccak256(data), keyTuple[0]);
+  }
+
+  function onBeforeSpliceStaticData(
+    ResourceId sourceTableId,
+    bytes32[] memory keyTuple,
+    uint48,
+    bytes memory
+  ) public override {
+    // Remove the key from the list of keys with the previous value
+    FieldLayout fieldLayout = Tables.getFieldLayout(sourceTableId);
+    bytes32 previousValue = _getRecordValueHash(sourceTableId, keyTuple, fieldLayout);
+    ResourceId targetTableId = getTargetTableId(MODULE_NAMESPACE, sourceTableId);
+    _removeKeyFromList(targetTableId, keyTuple[0], previousValue);
+  }
+
+  function onAfterSpliceStaticData(
+    ResourceId sourceTableId,
+    bytes32[] memory keyTuple,
+    uint48,
+    bytes memory
+  ) public override {
+    // Add the key to the list of keys with the new value
+    FieldLayout fieldLayout = Tables.getFieldLayout(sourceTableId);
+    bytes32 newValue = _getRecordValueHash(sourceTableId, keyTuple, fieldLayout);
+    ResourceId targetTableId = getTargetTableId(MODULE_NAMESPACE, sourceTableId);
+    KeysWithValue.push(targetTableId, newValue, keyTuple[0]);
+  }
+
+  function onBeforeSpliceDynamicData(
+    ResourceId sourceTableId,
+    bytes32[] memory keyTuple,
+    uint8,
+    uint40,
+    uint40,
+    EncodedLengths,
+    bytes memory
+  ) public override {
+    // Remove the key from the list of keys with the previous value
+    FieldLayout fieldLayout = Tables.getFieldLayout(sourceTableId);
+    bytes32 previousValue = _getRecordValueHash(sourceTableId, keyTuple, fieldLayout);
+    ResourceId targetTableId = getTargetTableId(MODULE_NAMESPACE, sourceTableId);
+    _removeKeyFromList(targetTableId, keyTuple[0], previousValue);
+  }
+
+  function onAfterSpliceDynamicData(
+    ResourceId sourceTableId,
+    bytes32[] memory keyTuple,
+    uint8,
+    uint40,
+    uint40,
+    EncodedLengths,
+    bytes memory
+  ) public override {
+    // Add the key to the list of keys with the new value
+    FieldLayout fieldLayout = Tables.getFieldLayout(sourceTableId);
+    bytes32 newValue = _getRecordValueHash(sourceTableId, keyTuple, fieldLayout);
+    ResourceId targetTableId = getTargetTableId(MODULE_NAMESPACE, sourceTableId);
+    KeysWithValue.push(targetTableId, newValue, keyTuple[0]);
+  }
+
+  function onBeforeDeleteRecord(
+    ResourceId sourceTableId,
+    bytes32[] memory keyTuple,
+    FieldLayout fieldLayout
+  ) public override {
+    // Remove the key from the list of keys with the previous value
+    bytes32 previousValue = _getRecordValueHash(sourceTableId, keyTuple, fieldLayout);
+    ResourceId targetTableId = getTargetTableId(MODULE_NAMESPACE, sourceTableId);
+    _removeKeyFromList(targetTableId, keyTuple[0], previousValue);
+  }
+
+  function _getRecordValueHash(
+    ResourceId sourceTableId,
+    bytes32[] memory keyTuple,
+    FieldLayout fieldLayout
+  ) internal view returns (bytes32 valueHash) {
+    (bytes memory staticData, EncodedLengths encodedLengths, bytes memory dynamicData) = _world().getRecord(
+      sourceTableId,
+      keyTuple,
+      fieldLayout
+    );
+    if (dynamicData.length > 0) {
+      return keccak256(abi.encodePacked(staticData, encodedLengths, dynamicData));
+    } else {
+      return keccak256(staticData);
+    }
+  }
+
+  function _removeKeyFromList(ResourceId targetTableId, bytes32 key, bytes32 valueHash) internal {
+    // Get the keys with the previous value excluding the current key
+    bytes32[] memory keysWithPreviousValue = KeysWithValue.get(targetTableId, valueHash).filter(key);
+
+    if (keysWithPreviousValue.length == 0) {
+      // Delete the list of keys in this table
+      KeysWithValue.deleteRecord(targetTableId, valueHash);
+    } else {
+      // Set the keys with the previous value
+      KeysWithValue.set(targetTableId, valueHash, keysWithPreviousValue);
+    }
+  }
+}

package/src/modules/keyswithvalue/KeysWithValueModule.sol

@@ -0,0 +1,103 @@
+// SPDX-License-Identifier: MIT
+pragma solidity >=0.8.24;
+import { StoreSwitch } from "@latticexyz/store/src/StoreSwitch.sol";
+import { BEFORE_SET_RECORD, BEFORE_SPLICE_STATIC_DATA, AFTER_SPLICE_STATIC_DATA, BEFORE_SPLICE_DYNAMIC_DATA, AFTER_SPLICE_DYNAMIC_DATA, BEFORE_DELETE_RECORD } from "@latticexyz/store/src/storeHookTypes.sol";
+import { ResourceIds } from "@latticexyz/store/src/codegen/tables/ResourceIds.sol";
+
+import { Module } from "@latticexyz/world/src/Module.sol";
+import { IBaseWorld } from "@latticexyz/world/src/codegen/interfaces/IBaseWorld.sol";
+import { InstalledModules } from "@latticexyz/world/src/codegen/index.sol";
+
+import { WorldContextConsumer } from "@latticexyz/world/src/WorldContext.sol";
+import { ResourceId, WorldResourceIdInstance } from "@latticexyz/world/src/WorldResourceId.sol";
+import { revertWithBytes } from "@latticexyz/world/src/revertWithBytes.sol";
+
+import { MODULE_NAMESPACE } from "./constants.sol";
+import { KeysWithValueHook } from "./KeysWithValueHook.sol";
+import { KeysWithValue } from "./tables/KeysWithValue.sol";
+import { getTargetTableId } from "./getTargetTableId.sol";
+
+/**
+ * This module deploys a hook that is called when a value is set in the `sourceTableId`
+ * provided in the install methods arguments. The hook keeps track of the keys that map to a given value.
+ * from value to list of keys with this value. This mapping is stored in a table registered
+ * by the module at the `targetTableId` provided in the install methods arguments.
+ *
+ * Note: if a table with composite keys is used, only the first key is indexed
+ *
+ * Note: this module currently only supports `installRoot` (via `World.installRootModule`).
+ * TODO: add support for `install` (via `World.installModule`) by using `callFrom` with the `msgSender()`
+ */
+contract KeysWithValueModule is Module {
+  using WorldResourceIdInstance for ResourceId;
+
+  // The KeysWithValueHook is deployed once and infers the target table id
+  // from the source table id (passed as argument to the hook methods)
+  KeysWithValueHook private immutable hook = new KeysWithValueHook();
+
+  function installRoot(bytes memory encodedArgs) public {
+    // Naive check to ensure this is only installed once
+    // TODO: only revert if there's nothing to do
+    requireNotInstalled(__self, encodedArgs);
+
+    // Extract source table id from args
+    ResourceId sourceTableId = ResourceId.wrap(abi.decode(encodedArgs, (bytes32)));
+    ResourceId targetTableId = getTargetTableId(MODULE_NAMESPACE, sourceTableId);
+
+    IBaseWorld world = IBaseWorld(_world());
+
+    // Register the target namespace if it doesn't exist yet
+    if (!ResourceIds.getExists(targetTableId.getNamespaceId())) {
+      (bool registrationSuccess, bytes memory registrationReturnData) = address(world).delegatecall(
+        abi.encodeCall(world.registerNamespace, (targetTableId.getNamespaceId()))
+      );
+      if (!registrationSuccess) revertWithBytes(registrationReturnData);
+    }
+
+    // Register the target table
+    (bool success, bytes memory returnData) = address(world).delegatecall(
+      abi.encodeCall(
+        world.registerTable,
+        (
+          targetTableId,
+          KeysWithValue._fieldLayout,
+          KeysWithValue._keySchema,
+          KeysWithValue._valueSchema,
+          KeysWithValue.getKeyNames(),
+          KeysWithValue.getFieldNames()
+        )
+      )
+    );
+
+    if (!success) revertWithBytes(returnData);
+
+    // Grant the hook access to the target table
+    (success, returnData) = address(world).delegatecall(
+      abi.encodeCall(world.grantAccess, (targetTableId, address(hook)))
+    );
+
+    if (!success) revertWithBytes(returnData);
+
+    // Register a hook that is called when a value is set in the source table
+    (success, returnData) = address(world).delegatecall(
+      abi.encodeCall(
+        world.registerStoreHook,
+        (
+          sourceTableId,
+          hook,
+          BEFORE_SET_RECORD |
+            BEFORE_SPLICE_STATIC_DATA |
+            AFTER_SPLICE_STATIC_DATA |
+            BEFORE_SPLICE_DYNAMIC_DATA |
+            AFTER_SPLICE_DYNAMIC_DATA |
+            BEFORE_DELETE_RECORD
+        )
+      )
+    );
+    if (!success) revertWithBytes(returnData);
+  }
+
+  function install(bytes memory) public pure {
+    revert Module_NonRootInstallNotSupported();
+  }
+}

package/src/modules/keyswithvalue/constants.sol

@@ -0,0 +1,7 @@
+// SPDX-License-Identifier: MIT
+pragma solidity >=0.8.24;
+
+// Limiting the module namespace to 7 bytes so the remaining 7 bytes
+// can be used for an identifier of the source table namespace to avoid
+// collisions between tables with the same name in different namespaces
+bytes7 constant MODULE_NAMESPACE = "keywval";