@latticexyz/world-modules 2.0.12-main-ecc8f658 → 2.0.12-type-resolutions-effc7ab1

package/src/modules/keysintable/KeysInTableHook.sol

@@ -1,141 +0,0 @@
-// SPDX-License-Identifier: MIT
-pragma solidity >=0.8.24;
-
-import { EncodedLengths } from "@latticexyz/store/src/EncodedLengths.sol";
-import { FieldLayout } from "@latticexyz/store/src/FieldLayout.sol";
-import { StoreHook } from "@latticexyz/store/src/StoreHook.sol";
-import { ResourceId } from "@latticexyz/store/src/ResourceId.sol";
-
-import { KeysInTable } from "./tables/KeysInTable.sol";
-import { UsedKeysIndex } from "./tables/UsedKeysIndex.sol";
-
-/**
- * Note: if a table with composite keys is used, only the first five keys of the tuple are indexed
- */
-contract KeysInTableHook is StoreHook {
-  function handleSet(ResourceId tableId, bytes32[] memory keyTuple) internal {
-    bytes32 keysHash = keccak256(abi.encode(keyTuple));
-
-    // If the keyTuple has not yet been set in the table...
-    if (!UsedKeysIndex.getHas(tableId, keysHash)) {
-      uint40 length = uint40(KeysInTable.lengthKeys0(tableId));
-
-      // Push the keyTuple to the list of keys in this table
-      if (keyTuple.length > 0) {
-        KeysInTable.pushKeys0(tableId, keyTuple[0]);
-        if (keyTuple.length > 1) {
-          KeysInTable.pushKeys1(tableId, keyTuple[1]);
-          if (keyTuple.length > 2) {
-            KeysInTable.pushKeys2(tableId, keyTuple[2]);
-            if (keyTuple.length > 3) {
-              KeysInTable.pushKeys3(tableId, keyTuple[3]);
-              if (keyTuple.length > 4) {
-                KeysInTable.pushKeys4(tableId, keyTuple[4]);
-              }
-            }
-          }
-        }
-      }
-
-      // Update the index to avoid duplicating this keyTuple in the array
-      UsedKeysIndex.set(tableId, keysHash, true, length);
-    }
-  }
-
-  function onBeforeSetRecord(
-    ResourceId tableId,
-    bytes32[] memory keyTuple,
-    bytes memory,
-    EncodedLengths,
-    bytes memory,
-    FieldLayout
-  ) public override {
-    handleSet(tableId, keyTuple);
-  }
-
-  function onAfterSpliceStaticData(
-    ResourceId tableId,
-    bytes32[] memory keyTuple,
-    uint48,
-    bytes memory
-  ) public override {
-    handleSet(tableId, keyTuple);
-  }
-
-  function onAfterSpliceDynamicData(
-    ResourceId tableId,
-    bytes32[] memory keyTuple,
-    uint8,
-    uint40,
-    uint40,
-    EncodedLengths,
-    bytes memory
-  ) public override {
-    handleSet(tableId, keyTuple);
-  }
-
-  function onBeforeDeleteRecord(ResourceId tableId, bytes32[] memory keyTuple, FieldLayout) public override {
-    bytes32 keysHash = keccak256(abi.encode(keyTuple));
-    (bool has, uint40 index) = UsedKeysIndex.get(tableId, keysHash);
-
-    // If the keyTuple was part of the table...
-    if (has) {
-      // Delete the index as the keyTuple is not in the table anymore
-      UsedKeysIndex.deleteRecord(tableId, keysHash);
-
-      uint40 length = uint40(KeysInTable.lengthKeys0(tableId));
-
-      if (length == 1) {
-        // Delete the list of keys in this table
-        KeysInTable.deleteRecord(tableId);
-      } else {
-        if (keyTuple.length > 0) {
-          bytes32[] memory lastKeyTuple = new bytes32[](keyTuple.length);
-
-          bytes32 lastKey = KeysInTable.getItemKeys0(tableId, length - 1);
-          lastKeyTuple[0] = lastKey;
-
-          // Remove the keyTuple from the list of keys in this table
-          KeysInTable.updateKeys0(tableId, index, lastKey);
-          KeysInTable.popKeys0(tableId);
-
-          if (keyTuple.length > 1) {
-            lastKey = KeysInTable.getItemKeys1(tableId, length - 1);
-            lastKeyTuple[1] = lastKey;
-
-            KeysInTable.updateKeys1(tableId, index, lastKey);
-            KeysInTable.popKeys1(tableId);
-
-            if (keyTuple.length > 2) {
-              lastKey = KeysInTable.getItemKeys2(tableId, length - 1);
-              lastKeyTuple[2] = lastKey;
-
-              KeysInTable.updateKeys2(tableId, index, lastKey);
-              KeysInTable.popKeys2(tableId);
-
-              if (keyTuple.length > 3) {
-                lastKey = KeysInTable.getItemKeys3(tableId, length - 1);
-                lastKeyTuple[3] = lastKey;
-
-                KeysInTable.updateKeys3(tableId, index, lastKey);
-                KeysInTable.popKeys3(tableId);
-
-                if (keyTuple.length > 4) {
-                  lastKey = KeysInTable.getItemKeys4(tableId, length - 1);
-                  lastKeyTuple[4] = lastKey;
-
-                  KeysInTable.updateKeys4(tableId, index, lastKey);
-                  KeysInTable.popKeys4(tableId);
-                }
-              }
-            }
-          }
-
-          // Update the index of lastKeyTuple after swapping it with the deleted keyTuple
-          bytes32 lastKeyHash = keccak256(abi.encode(lastKeyTuple));
-          UsedKeysIndex.setIndex(tableId, lastKeyHash, index);
-        }
-      }
-    }
-  }
-}

package/src/modules/keysintable/KeysInTableModule.sol

@@ -1,110 +0,0 @@
-// SPDX-License-Identifier: MIT
-pragma solidity >=0.8.24;
-
-import { BEFORE_SET_RECORD, AFTER_SPLICE_STATIC_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 { ResourceId, WorldResourceIdInstance } from "@latticexyz/world/src/WorldResourceId.sol";
-import { revertWithBytes } from "@latticexyz/world/src/revertWithBytes.sol";
-
-import { KeysInTableHook } from "./KeysInTableHook.sol";
-import { KeysInTable } from "./tables/KeysInTable.sol";
-import { UsedKeysIndex } from "./tables/UsedKeysIndex.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 are in a given table.
- * This mapping is stored in a global table that is registered when the module is first installed.
- *
- * 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 KeysInTableModule is Module {
-  using WorldResourceIdInstance for ResourceId;
-
-  // The KeysInTableHook is deployed once and infers the target table id
-  // from the source table id (passed as argument to the hook methods)
-  KeysInTableHook private immutable hook = new KeysInTableHook();
-
-  function installRoot(bytes memory encodedArgs) public override {
-    // 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)));
-
-    IBaseWorld world = IBaseWorld(_world());
-
-    // Initialize variable to reuse in low level calls
-    bool success;
-    bytes memory returnData;
-
-    if (!ResourceIds._getExists(KeysInTable._tableId)) {
-      // Register the tables
-      (success, returnData) = address(world).delegatecall(
-        abi.encodeCall(
-          world.registerTable,
-          (
-            KeysInTable._tableId,
-            KeysInTable._fieldLayout,
-            KeysInTable._keySchema,
-            KeysInTable._valueSchema,
-            KeysInTable.getKeyNames(),
-            KeysInTable.getFieldNames()
-          )
-        )
-      );
-      if (!success) revertWithBytes(returnData);
-
-      (success, returnData) = address(world).delegatecall(
-        abi.encodeCall(
-          world.registerTable,
-          (
-            UsedKeysIndex._tableId,
-            UsedKeysIndex._fieldLayout,
-            UsedKeysIndex._keySchema,
-            UsedKeysIndex._valueSchema,
-            UsedKeysIndex.getKeyNames(),
-            UsedKeysIndex.getFieldNames()
-          )
-        )
-      );
-      if (!success) revertWithBytes(returnData);
-
-      // Grant the hook access to the tables
-      (success, returnData) = address(world).delegatecall(
-        abi.encodeCall(world.grantAccess, (KeysInTable._tableId, address(hook)))
-      );
-      if (!success) revertWithBytes(returnData);
-
-      (success, returnData) = address(world).delegatecall(
-        abi.encodeCall(world.grantAccess, (UsedKeysIndex._tableId, 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 | AFTER_SPLICE_STATIC_DATA | AFTER_SPLICE_DYNAMIC_DATA | BEFORE_DELETE_RECORD
-        )
-      )
-    );
-  }
-
-  function install(bytes memory) public pure {
-    revert Module_NonRootInstallNotSupported();
-  }
-}

package/src/modules/keysintable/constants.sol

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

package/src/modules/keysintable/getKeysInTable.sol

@@ -1,81 +0,0 @@
-// SPDX-License-Identifier: MIT
-pragma solidity >=0.8.24;
-
-import { IStore } from "@latticexyz/store/src/IStore.sol";
-import { Schema } from "@latticexyz/store/src/Schema.sol";
-import { StoreSwitch } from "@latticexyz/store/src/StoreSwitch.sol";
-import { ResourceId } from "@latticexyz/store/src/ResourceId.sol";
-
-import { KeysInTable } from "./tables/KeysInTable.sol";
-
-/**
- * Get a list of keys in the given table.
- *
- * Note: this util can only be called within the context of a Store (e.g. from a System or Module).
- * For usage outside of a Store, use the overload that takes an explicit store argument.
- */
-function getKeysInTable(ResourceId tableId) view returns (bytes32[][] memory keyTuples) {
-  /**
-   * Note: this module only supports up to 5 composite keys.
-   */
-
-  Schema keySchema = StoreSwitch.getKeySchema(tableId);
-  uint256 numFields = keySchema.numFields();
-  uint256 length = KeysInTable.lengthKeys0(tableId);
-  keyTuples = new bytes32[][](length);
-
-  for (uint256 i; i < length; i++) {
-    keyTuples[i] = new bytes32[](numFields); // the length of the key tuple depends on the key schema
-
-    if (numFields > 0) {
-      keyTuples[i][0] = KeysInTable.getItemKeys0(tableId, i);
-      if (numFields > 1) {
-        keyTuples[i][1] = KeysInTable.getItemKeys1(tableId, i);
-        if (numFields > 2) {
-          keyTuples[i][2] = KeysInTable.getItemKeys2(tableId, i);
-          if (numFields > 3) {
-            keyTuples[i][3] = KeysInTable.getItemKeys3(tableId, i);
-            if (numFields > 4) {
-              keyTuples[i][4] = KeysInTable.getItemKeys4(tableId, i);
-            }
-          }
-        }
-      }
-    }
-  }
-}
-
-/**
- * Get a list of keys in the given table for the given store.
- */
-function getKeysInTable(IStore store, ResourceId tableId) view returns (bytes32[][] memory keyTuples) {
-  /**
-   * Note: this module only supports up to 5 composite keys.
-   */
-
-  Schema keySchema = store.getKeySchema(tableId);
-
-  uint256 numFields = keySchema.numFields();
-  uint256 length = KeysInTable.lengthKeys0(store, tableId);
-  keyTuples = new bytes32[][](length);
-
-  for (uint256 i; i < length; i++) {
-    keyTuples[i] = new bytes32[](numFields); // the length of the key tuple depends on the key schema
-
-    if (numFields > 0) {
-      keyTuples[i][0] = KeysInTable.getItemKeys0(store, tableId, i);
-      if (numFields > 1) {
-        keyTuples[i][1] = KeysInTable.getItemKeys1(store, tableId, i);
-        if (numFields > 2) {
-          keyTuples[i][2] = KeysInTable.getItemKeys2(store, tableId, i);
-          if (numFields > 3) {
-            keyTuples[i][3] = KeysInTable.getItemKeys3(store, tableId, i);
-            if (numFields > 4) {
-              keyTuples[i][4] = KeysInTable.getItemKeys4(store, tableId, i);
-            }
-          }
-        }
-      }
-    }
-  }
-}

package/src/modules/keysintable/hasKey.sol

@@ -1,28 +0,0 @@
-// SPDX-License-Identifier: MIT
-pragma solidity >=0.8.24;
-
-import { IStore } from "@latticexyz/store/src/IStore.sol";
-import { ResourceId } from "@latticexyz/store/src/ResourceId.sol";
-
-import { UsedKeysIndex } from "./tables/UsedKeysIndex.sol";
-
-/**
- * Get whether the keyTuple is in the given table.
- *
- * Note: this util can only be called within the context of a Store (e.g. from a System or Module).
- * For usage outside of a Store, use the overload that takes an explicit store argument.
- */
-function hasKey(ResourceId tableId, bytes32[] memory keyTuple) view returns (bool) {
-  bytes32 keysHash = keccak256(abi.encode(keyTuple));
-
-  return UsedKeysIndex.getHas(tableId, keysHash);
-}
-
-/**
- * Get whether the keyTuple is in the given table for the given store.
- */
-function hasKey(IStore store, ResourceId tableId, bytes32[] memory keyTuple) view returns (bool) {
-  bytes32 keysHash = keccak256(abi.encode(keyTuple));
-
-  return UsedKeysIndex.getHas(store, tableId, keysHash);
-}

package/src/modules/keysintable/query.sol

@@ -1,200 +0,0 @@
-// SPDX-License-Identifier: MIT
-pragma solidity >=0.8.24;
-
-import { IStore } from "@latticexyz/store/src/IStore.sol";
-import { EncodedLengths } from "@latticexyz/store/src/EncodedLengths.sol";
-import { ResourceId } from "@latticexyz/store/src/ResourceId.sol";
-
-import { getKeysInTable } from "./getKeysInTable.sol";
-import { getKeysWithValue } from "../keyswithvalue/getKeysWithValue.sol";
-import { ArrayLib } from "../utils/ArrayLib.sol";
-
-enum QueryType {
-  Has,
-  Not,
-  HasValue,
-  NotValue
-}
-
-struct QueryFragment {
-  QueryType queryType;
-  ResourceId tableId;
-  bytes value;
-}
-
-function valuesToTuples(bytes32[] memory flatArr) pure returns (bytes32[][] memory arr) {
-  arr = new bytes32[][](flatArr.length);
-  for (uint256 i; i < flatArr.length; i++) {
-    arr[i] = new bytes32[](1);
-    arr[i][0] = flatArr[i];
-  }
-}
-
-/**
- * Helper function to check whether a given key passes a given query fragment.
- *
- * Note: this util can only be called within the context of a Store (e.g. from a System or Module).
- * For usage outside of a Store, use the overload that takes an explicit store argument.
- *
- * @param keyTuple Key to check.
- * @param fragment Query fragment to check.
- */
-function passesQueryFragment(bytes32[] memory keyTuple, QueryFragment memory fragment) view returns (bool) {
-  if (fragment.queryType == QueryType.Has) {
-    // Key must be in given table
-    return ArrayLib.includes(getKeysInTable(fragment.tableId), keyTuple);
-  }
-
-  if (fragment.queryType == QueryType.HasValue) {
-    // Key must have the given value
-    return
-      ArrayLib.includes(
-        valuesToTuples(
-          getKeysWithValue(fragment.tableId, fragment.value, EncodedLengths.wrap(bytes32(0)), new bytes(0))
-        ),
-        keyTuple
-      );
-  }
-
-  if (fragment.queryType == QueryType.Not) {
-    // Key must not be in given table
-    return !ArrayLib.includes(getKeysInTable(fragment.tableId), keyTuple);
-  }
-
-  if (fragment.queryType == QueryType.NotValue) {
-    // Key must not have the given value
-    return
-      !ArrayLib.includes(
-        valuesToTuples(
-          getKeysWithValue(fragment.tableId, fragment.value, EncodedLengths.wrap(bytes32(0)), new bytes(0))
-        ),
-        keyTuple
-      );
-  }
-
-  return false;
-}
-
-/**
- * Helper function to check whether a given key passes a given query fragment.
- * @param keyTuple Key to check.
- * @param fragment Query fragment to check.
- */
-function passesQueryFragment(
-  IStore store,
-  bytes32[] memory keyTuple,
-  QueryFragment memory fragment
-) view returns (bool) {
-  if (fragment.queryType == QueryType.Has) {
-    // Key must be in given table
-    return ArrayLib.includes(getKeysInTable(store, fragment.tableId), keyTuple);
-  }
-
-  if (fragment.queryType == QueryType.HasValue) {
-    // Key must be have the given value
-    return
-      ArrayLib.includes(
-        valuesToTuples(
-          getKeysWithValue(store, fragment.tableId, fragment.value, EncodedLengths.wrap(bytes32(0)), new bytes(0))
-        ),
-        keyTuple
-      );
-  }
-
-  if (fragment.queryType == QueryType.Not) {
-    // Key must not be in given table
-    return !ArrayLib.includes(getKeysInTable(store, fragment.tableId), keyTuple);
-  }
-
-  if (fragment.queryType == QueryType.NotValue) {
-    // Key must not have the given value
-    return
-      !ArrayLib.includes(
-        valuesToTuples(
-          getKeysWithValue(store, fragment.tableId, fragment.value, EncodedLengths.wrap(bytes32(0)), new bytes(0))
-        ),
-        keyTuple
-      );
-  }
-
-  return false;
-}
-
-/**
- * Execute the given query and return a list of keys
- * The first fragment should be Has or HasValue
- *
- * Note: this util can only be called within the context of a Store (e.g. from a System or Module).
- * For usage outside of a Store, use the overload that takes an explicit store argument.
- *
- * @param fragments List of query fragments to execute
- * @return keyTuples List of keys matching the query
- */
-function query(QueryFragment[] memory fragments) view returns (bytes32[][] memory keyTuples) {
-  // Create the first interim result
-  keyTuples = fragments[0].queryType == QueryType.Has
-    ? getKeysInTable(fragments[0].tableId)
-    : valuesToTuples(
-      getKeysWithValue(fragments[0].tableId, fragments[0].value, EncodedLengths.wrap(bytes32(0)), new bytes(0))
-    );
-
-  for (uint256 i = 1; i < fragments.length; i++) {
-    bytes32[][] memory result = new bytes32[][](0);
-
-    for (uint256 j; j < keyTuples.length; j++) {
-      bool passes = passesQueryFragment(keyTuples[j], fragments[i]);
-      if (passes) {
-        // Increase the length of result array and add the new key
-        uint256 length = result.length;
-
-        bytes32[][] memory newResult = new bytes32[][](length + 1);
-        for (uint256 k; k < length; k++) {
-          newResult[k] = result[k];
-        }
-        result = newResult;
-
-        result[length] = keyTuples[j];
-      }
-    }
-
-    keyTuples = result;
-  }
-}
-
-/**
- * Execute the given query and return a list of keys
- * The first fragment should be Has or HasValue
- * @param fragments List of query fragments to execute
- * @return keyTuples List of keys matching the query
- */
-function query(IStore store, QueryFragment[] memory fragments) view returns (bytes32[][] memory keyTuples) {
-  // Create the first interim result
-  keyTuples = fragments[0].queryType == QueryType.Has
-    ? getKeysInTable(store, fragments[0].tableId)
-    : valuesToTuples(
-      getKeysWithValue(store, fragments[0].tableId, fragments[0].value, EncodedLengths.wrap(bytes32(0)), new bytes(0))
-    );
-
-  for (uint256 i = 1; i < fragments.length; i++) {
-    bytes32[][] memory result = new bytes32[][](0);
-
-    for (uint256 j; j < keyTuples.length; j++) {
-      bool passes = passesQueryFragment(store, keyTuples[j], fragments[i]);
-      if (passes) {
-        // Increase the length of result array
-        uint256 length = result.length;
-
-        bytes32[][] memory newResult = new bytes32[][](length + 1);
-        for (uint256 k; k < length; k++) {
-          newResult[k] = result[k];
-        }
-        result = newResult;
-
-        // Append the new key
-        result[length] = keyTuples[j];
-      }
-    }
-
-    keyTuples = result;
-  }
-}