feat(store-consumer): extract store consumer contracts (#3345)

Author: vdrg

.changeset/nine-countries-nail.md

@@ -0,0 +1,7 @@
+---
+"@latticexyz/store-consumer": patch
+"@latticexyz/world-module-erc20": patch
+---
+
+Extracted StoreConsumer base contracts into an independent package.
+Added a `registerNamespace` boolean to `WithWorld` to provide more control over namespace registration.

packages/store-consumer/.gitignore

@@ -0,0 +1,2 @@
+cache
+out

packages/store-consumer/CHANGELOG.md

@@ -0,0 +1 @@
+# @latticexyz/store-consumer

packages/store-consumer/README.md

@@ -0,0 +1,11 @@
+# Store Consumer Contracts
+
+> :warning: **Important note: these contracts have not been audited yet, so any production use is discouraged for now.**
+
+This set of contracts provides an easy way to make use of a `Store` for read and write operations, with the possibility of fully abstracting away the type of underlying store being used.
+
+- `StoreConsumer`: all contracts that don't explicitly need to know which type of store is being used can inherit from `StoreConsumer`, which abstracts the way in which `ResourceId`s are encoded. This allows us to have composable contracts whose implementations don't depend on the type of the underlying Store.
+- `WithStore(address) is StoreConsumer`: this contract initializes the store, using the contract's internal storage or the provided external `Store`. It encodes `ResourceId`s using `ResourceIdLib` from the `@latticexyz/store` package.
+- `WithWorld(IBaseWorld, bytes14) is WithStore`: initializes the store and also registers the provided namespace in the provided World. It encodes `ResourceId`s using `WorldResourceIdLib` (using the namespace). It also provides an `onlyNamespace` modifier, which can be used to restrict access to certain functions, only allowing calls from addresses that have access to the namespace.
+
+For examples of how these are used in practice you can check the [examples directory](./src/examples/) or our [ERC20 World Module](../world-module-erc20/).

packages/store-consumer/foundry.toml

@@ -0,0 +1,15 @@
+[profile.default]
+solc = "0.8.24"
+ffi = false
+fuzz_runs = 256
+optimizer = true
+optimizer_runs = 3000
+verbosity = 2
+allow_paths = ["../../node_modules", "../"]
+src = "src"
+out = "out"
+bytecode_hash = "none"
+extra_output_files = [
+  "abi",
+  "evm.bytecode"
+]

packages/store-consumer/gas-report.json

@@ -0,0 +1 @@
+[]

packages/store-consumer/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@latticexyz/store-consumer",
+  "version": "2.2.14",
+  "description": "Store Consumer Contracts",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/latticexyz/mud.git",
+    "directory": "packages/store-consumer"
+  },
+  "license": "MIT",
+  "type": "module",
+  "exports": {
+    "./out/*": "./out/*"
+  },
+  "typesVersions": {
+    "*": {}
+  },
+  "files": [
+    "out",
+    "src"
+  ],
+  "scripts": {
+    "build": "pnpm run build:abi && pnpm run build:abi-ts",
+    "build:abi": "forge build",
+    "build:abi-ts": "abi-ts",
+    "clean": "pnpm run clean:abi && pnpm run clean:js",
+    "clean:abi": "forge clean",
+    "clean:js": "shx rm -rf dist",
+    "clean:mud": "shx rm -rf src/**/codegen",
+    "dev": "tsup --watch",
+    "gas-report": "gas-report --save gas-report.json",
+    "lint": "solhint --config ./.solhint.json 'src/**/*.sol'",
+    "test": "forge test",
+    "test:ci": "pnpm run test"
+  },
+  "dependencies": {
+    "@latticexyz/schema-type": "workspace:*",
+    "@latticexyz/store": "workspace:*",
+    "@latticexyz/world": "workspace:*"
+  },
+  "devDependencies": {
+    "@latticexyz/abi-ts": "workspace:*",
+    "@latticexyz/gas-report": "workspace:*",
+    "@types/node": "^18.15.11",
+    "forge-std": "https://github.com/foundry-rs/forge-std.git#1eea5bae12ae557d589f9f0f0edae2faa47cb262",
+    "solhint": "^3.3.7",
+    "tsup": "^6.7.0",
+    "vitest": "0.34.6"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

packages/store-consumer/remappings.txt

@@ -0,0 +1,2 @@
+forge-std/=node_modules/forge-std/src/
+@latticexyz/=node_modules/@latticexyz/

packages/store-consumer/src/examples/SimpleVault.sol

@@ -0,0 +1,33 @@
+// SPDX-License-Identifier: MIT
+pragma solidity >=0.8.24;
+
+import { ResourceId } from "@latticexyz/store/src/ResourceId.sol";
+import { IBaseWorld } from "@latticexyz/world/src/codegen/interfaces/IBaseWorld.sol";
+import { NamespaceOwner } from "@latticexyz/world/src/codegen/tables/NamespaceOwner.sol";
+
+import { WithWorld } from "../experimental/WithWorld.sol";
+
+interface IERC20 {
+  function transfer(address to, uint256 value) external returns (bool);
+  function allowance(address owner, address spender) external view returns (uint256);
+  function approve(address spender, uint256 value) external returns (bool);
+  function transferFrom(address from, address to, uint256 value) external returns (bool);
+}
+
+/**
+ * @title SimpleVault (NOT AUDITED)
+ * @dev Simple example of a Vault that allows accounts with namespace access to transfer its tokens out
+ * IMPORTANT: this contract expects an existing namespace
+ */
+contract SimpleVault is WithWorld {
+  error SimpleVault_TransferFailed();
+
+  constructor(IBaseWorld world, bytes14 namespace) WithWorld(world, namespace, false) {}
+
+  // Only accounts with namespace access (e.g. namespace systems) can transfer the ERC20 tokens held by this contract
+  function transferTo(IERC20 token, address to, uint256 amount) external onlyNamespace {
+    require(token.transfer(to, amount), "Transfer failed");
+  }
+
+  // ... other methods to deposit, etc
+}