feat(world): add World prototype

.github/workflows/gasreport.yml

@@ -5,6 +5,7 @@ on:
   pull_request:
     paths:
       - packages/store/**
+      - packages/world/**
 
 jobs:
   gas-report:
@@ -29,9 +30,5 @@ jobs:
       - name: Install local CLI
         run: cd packages/cli && yarn build && npm link && cd ../..
 
-      - name: Run gas report
-        run: yarn workspace @latticexyz/store run gasreport
-
-      - uses: stefanzweifel/git-auto-commit-action@v4
-        with:
-          commit_message: "test: update gas report"
+      - name: Verify that gas report is up to date
+        run: yarn workspace @latticexyz/store run gasreport && yarn workspace @latticexyz/world run gasreport && if [ -n "$(git status --porcelain)" ]; then exit 0; fi

.vscode/settings.json

@@ -9,6 +9,7 @@
     "ds-test/=node_modules/ds-test/src/",
     "solecs/=node_modules/@latticexyz/solecs/src/",
     "royalty-registry/=node_modules/@manifoldxzy/royalty-registry/contracts/",
-    "std-contracts/=node_modules/@latticexyz/std-contracts/src/"
+    "std-contracts/=node_modules/@latticexyz/std-contracts/src/",
+    "@latticexyz/=node_modules/@latticexyz/"
   ]
 }

package.json

@@ -13,6 +13,7 @@
       "packages/schema-type",
       "packages/solecs",
       "packages/store",
+      "packages/world",
       "packages/cli",
       "packages/recs",
       "packages/react",

packages/store/gas-report.txt

@@ -89,4 +89,4 @@
 (test/Vector2Table.t.sol) | set Vector2Table record [Vector2Table.set({ key: key, x: 1, y: 2 })]: 35773
 (test/Vector2Table.t.sol) | get Vector2Table record [Vector2 memory vector = Vector2Table.get(key)]: 3638
 (test/World.t.sol) | call autonomous system via World contract [WorldWithWorldTestSystem(address(world)).WorldTestSystem_move(entity, 1, 2)]: 43386
-(test/World.t.sol) | call delegate system via World contract [WorldWithWorldTestSystem(address(world)).WorldTestSystem_move(entity, 1, 2)]: 41226
+(test/World.t.sol) | call delegate system via World contract [WorldWithWorldTestSystem(address(world)).WorldTestSystem_move(entity, 1, 2)]: 41226

packages/store/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@latticexyz/store",
   "license": "MIT",
-  "version": "1.33.1",
+  "version": "1.34.0",
   "description": "Store",
   "types": "./types/ethers-contracts/",
   "repository": {

packages/store/src/IStore.sol

@@ -16,20 +16,20 @@ interface IStore {
   // Set full record (including full dynamic data)
   function setRecord(
     uint256 table,
-    bytes32[] memory key,
-    bytes memory data
+    bytes32[] calldata key,
+    bytes calldata data
   ) external;
 
   // Set partial data at schema index
   function setField(
     uint256 table,
-    bytes32[] memory key,
+    bytes32[] calldata key,
     uint8 schemaIndex,
-    bytes memory data
+    bytes calldata data
   ) external;
 
   // Register hooks to be called when a record or field is set or deleted
-  function registerHook(uint256 table, IStoreHook hooks) external;
+  function registerStoreHook(uint256 table, IStoreHook hooks) external;
 
   // Set full record (including full dynamic data)
   function deleteRecord(uint256 table, bytes32[] memory key) external;
@@ -40,14 +40,14 @@ interface IStore {
   // Get full record (including full array)
   function getRecord(
     uint256 table,
-    bytes32[] memory key,
+    bytes32[] calldata key,
     Schema schema
   ) external view returns (bytes memory data);
 
   // Get partial data at schema index
   function getField(
     uint256 table,
-    bytes32[] memory key,
+    bytes32[] calldata key,
     uint8 schemaIndex
   ) external view returns (bytes memory data);
 

packages/store/src/Slice.sol

@@ -18,7 +18,7 @@ using DecodeSlice for Slice global;
  * @title Static functions for Slice
  */
 library SliceLib {
-  error Slice_OutOfBounds();
+  error Slice_OutOfBounds(bytes data, uint256 start, uint256 end);
 
   uint256 constant MASK_LEN = uint256(type(uint128).max);
   uint256 constant MASK_PTR = uint256(type(uint128).max) << 128;
@@ -36,16 +36,24 @@ library SliceLib {
     return Slice.wrap((_pointer << 128) | (data.length & MASK_LEN));
   }
 
+  /**
+   * @dev Subslice a bytes array using the given start index until the end of the array (without copying data)
+   */
+  function getSubslice(bytes memory data, uint256 start) internal pure returns (Slice) {
+    return getSubslice(data, start, data.length);
+  }
+
   /**
    * @dev Subslice a bytes array using the given indexes (without copying data)
+   * The start index is inclusive, the end index is exclusive
    */
   function getSubslice(
     bytes memory data,
     uint256 start,
     uint256 end
   ) internal pure returns (Slice) {
     // TODO this check helps catch bugs and can eventually be removed
-    if (!(start <= end && end <= data.length)) revert Slice_OutOfBounds();
+    if (!(start <= end && end <= data.length)) revert Slice_OutOfBounds(data, start, end);
 
     uint256 _pointer;
     assembly {

packages/store/src/Store.sol

@@ -0,0 +1,42 @@
+// SPDX-License-Identifier: MIT
+pragma solidity >=0.8.0;
+
+import { SchemaType } from "./Types.sol";
+import { IStore, IStoreHook } from "./IStore.sol";
+import { StoreCore } from "./StoreCore.sol";
+import { Schema } from "./Schema.sol";
+
+abstract contract Store is IStore {
+  constructor() {
+    StoreCore.initialize();
+  }
+
+  function getSchema(uint256 table) public view virtual returns (Schema schema) {
+    schema = StoreCore.getSchema(table);
+  }
+
+  // Get full record (static and dynamic data, load schema from storage)
+  function getRecord(uint256 table, bytes32[] calldata key) public view virtual returns (bytes memory data) {
+    data = StoreCore.getRecord(table, key);
+  }
+
+  // Get full record (static and dynamic data)
+  function getRecord(
+    uint256 table,
+    bytes32[] calldata key,
+    Schema schema
+  ) public view virtual returns (bytes memory data) {
+    data = StoreCore.getRecord(table, key, schema);
+  }
+
+  // Get partial data at schema index
+  function getField(
+    uint256 table,
+    bytes32[] calldata key,
+    uint8 schemaIndex
+  ) public view virtual returns (bytes memory data) {
+    data = StoreCore.getField(table, key, schemaIndex);
+  }
+
+  function isStore() public view {}
+}

packages/store/src/StoreCore.sol

@@ -78,7 +78,7 @@ library StoreCore {
   /*
    * Register hooks to be called when a record or field is set or deleted
    */
-  function registerHook(uint256 table, IStoreHook hook) external {
+  function registerStoreHook(uint256 table, IStoreHook hook) external {
     HooksTable.push(table, address(hook));
   }
 

packages/store/src/StoreSwitch.sol

@@ -23,7 +23,9 @@ library StoreSwitch {
     assembly {
       codeSize := extcodesize(address())
     }
-    if (codeSize == 0) revert StoreSwitch_InvalidInsideConstructor();
+
+    // If the call is from within a constructor, use StoreCore to write to own storage
+    if (codeSize == 0) return true;
 
     // Check whether this contract implements the IStore interface
     try IStore(address(this)).isStore() {

packages/store/src/StoreView.sol

@@ -2,74 +2,56 @@
 pragma solidity >=0.8.0;
 
 import { SchemaType } from "./Types.sol";
-import { IStore, IStoreHook } from "./IStore.sol";
+import { IStoreHook } from "./IStore.sol";
 import { StoreCore } from "./StoreCore.sol";
 import { Schema } from "./Schema.sol";
+import { Store } from "./Store.sol";
 
 // Not abstract, so that it can be used as a base contract for testing and wherever write access is not needed
-contract StoreView is IStore {
+contract StoreView is Store {
   error StoreView_NotImplemented();
 
-  constructor() {
-    StoreCore.initialize();
-  }
-
-  function getSchema(uint256 table) public view virtual returns (Schema schema) {
-    schema = StoreCore.getSchema(table);
-  }
-
+  /**
+   * Not implemented in StoreView
+   */
   function registerSchema(uint256, Schema) public virtual {
     revert StoreView_NotImplemented();
   }
 
+  /**
+   * Not implemented in StoreView
+   */
   function setRecord(
     uint256,
-    bytes32[] memory,
-    bytes memory
+    bytes32[] calldata,
+    bytes calldata
   ) public virtual {
     revert StoreView_NotImplemented();
   }
 
-  // Set partial data at schema index
+  /**
+   * Not implemented in StoreView
+   */
   function setField(
     uint256,
-    bytes32[] memory,
+    bytes32[] calldata,
     uint8,
-    bytes memory
+    bytes calldata
   ) public virtual {
     revert StoreView_NotImplemented();
   }
 
-  function registerHook(uint256, IStoreHook) public virtual {
+  /**
+   * Not implemented in StoreView
+   */
+  function registerStoreHook(uint256, IStoreHook) public virtual {
     revert StoreView_NotImplemented();
   }
 
-  function deleteRecord(uint256, bytes32[] memory) public virtual {
+  /**
+   * Not implemented in StoreView
+   */
+  function deleteRecord(uint256, bytes32[] calldata) public virtual {
     revert StoreView_NotImplemented();
   }
-
-  // Get full record (including full array, load schema from storage)
-  function getRecord(uint256 table, bytes32[] memory key) public view virtual returns (bytes memory data) {
-    data = StoreCore.getRecord(table, key);
-  }
-
-  // Get full record (including full array)
-  function getRecord(
-    uint256 table,
-    bytes32[] memory key,
-    Schema schema
-  ) public view virtual returns (bytes memory data) {
-    data = StoreCore.getRecord(table, key, schema);
-  }
-
-  // Get partial data at schema index
-  function getField(
-    uint256 table,
-    bytes32[] memory key,
-    uint8 schemaIndex
-  ) public view virtual returns (bytes memory data) {
-    data = StoreCore.getField(table, key, schemaIndex);
-  }
-
-  function isStore() public view {}
 }