@latticexyz/world-consumer 2.2.20-06e48e0239a5c7994ce73b4d2752860743fec4b0

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@latticexyz/world-consumer",
+  "version": "2.2.20-06e48e0239a5c7994ce73b4d2752860743fec4b0",
+  "description": "World 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"
+  ],
+  "dependencies": {
+    "@latticexyz/schema-type": "2.2.20-06e48e0239a5c7994ce73b4d2752860743fec4b0",
+    "@latticexyz/world": "2.2.20-06e48e0239a5c7994ce73b4d2752860743fec4b0",
+    "@latticexyz/store": "2.2.20-06e48e0239a5c7994ce73b4d2752860743fec4b0"
+  },
+  "devDependencies": {
+    "forge-std": "https://github.com/foundry-rs/forge-std.git#1eea5bae12ae557d589f9f0f0edae2faa47cb262",
+    "solhint": "^3.3.7",
+    "@latticexyz/abi-ts": "2.2.20-06e48e0239a5c7994ce73b4d2752860743fec4b0",
+    "@latticexyz/gas-report": "2.2.20-06e48e0239a5c7994ce73b4d2752860743fec4b0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "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",
+    "clean:abi": "forge clean",
+    "dev": "echo 'nothing to watch'",
+    "gas-report": "gas-report --save gas-report.json",
+    "lint": "solhint --config ./.solhint.json 'src/**/*.sol'",
+    "test": "forge test",
+    "test:ci": "pnpm run test"
+  }
+}

package/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 { WorldConsumer } from "../experimental/WorldConsumer.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 WorldConsumer {
+  error SimpleVault_TransferFailed();
+
+  constructor(IBaseWorld world, bytes14 namespace) WorldConsumer(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 onlyWorld {
+    require(token.transfer(to, amount), "Transfer failed");
+  }
+
+  // ... other methods to deposit, etc
+}

package/src/experimental/WorldConsumer.sol

@@ -0,0 +1,82 @@
+// SPDX-License-Identifier: MIT
+pragma solidity >=0.8.24;
+
+import { RESOURCE_TABLE, RESOURCE_OFFCHAIN_TABLE } from "@latticexyz/store/src/storeResourceTypes.sol";
+import { StoreSwitch } from "@latticexyz/store/src/StoreSwitch.sol";
+import { ResourceIds } from "@latticexyz/store/src/codegen/tables/ResourceIds.sol";
+import { ResourceId } from "@latticexyz/store/src/ResourceId.sol";
+import { ResourceAccess } from "@latticexyz/world/src/codegen/tables/ResourceAccess.sol";
+import { IBaseWorld } from "@latticexyz/world/src/codegen/interfaces/IBaseWorld.sol";
+import { WorldResourceIdLib } from "@latticexyz/world/src/WorldResourceId.sol";
+import { WorldContextConsumer } from "@latticexyz/world/src/WorldContext.sol";
+import { System } from "@latticexyz/world/src/System.sol";
+
+abstract contract WorldConsumer is System {
+  bytes14 public immutable namespace;
+  ResourceId public immutable namespaceId;
+
+  error WorldConsumer_RootNamespaceNotAllowed(address worldAddress);
+  error WorldConsumer_NamespaceAlreadyExists(address worldAddress, bytes14 namespace);
+  error WorldConsumer_NamespaceDoesNotExists(address worldAddress, bytes14 namespace);
+  error WorldConsumer_CallerHasNoNamespaceAccess(address worldAddress, bytes14 namespace, address caller);
+  error WorldConsumer_CallerIsNotWorld(address worldAddress, address caller);
+  error WorldConsumer_ValueNotAllowed(address worldAddress);
+
+  modifier onlyWorld() {
+    address world = _world();
+    if (world != msg.sender) {
+      revert WorldConsumer_CallerIsNotWorld(world, msg.sender);
+    }
+    _;
+  }
+
+  modifier onlyNamespace() {
+    address world = _world();
+    if (world != msg.sender) {
+      revert WorldConsumer_CallerIsNotWorld(world, msg.sender);
+    }
+
+    // We use WorldContextConsumer directly as we already know the world is the caller
+    address sender = WorldContextConsumer._msgSender();
+    if (!ResourceAccess.get(namespaceId, sender)) {
+      revert WorldConsumer_CallerHasNoNamespaceAccess(world, namespace, sender);
+    }
+
+    _;
+  }
+
+  constructor(IBaseWorld _world, bytes14 _namespace, bool registerNamespace) {
+    address worldAddress = address(_world);
+    StoreSwitch.setStoreAddress(worldAddress);
+
+    if (_namespace == bytes14(0)) {
+      revert WorldConsumer_RootNamespaceNotAllowed(worldAddress);
+    }
+
+    namespace = _namespace;
+    namespaceId = WorldResourceIdLib.encodeNamespace(_namespace);
+    bool namespaceExists = ResourceIds.getExists(namespaceId);
+
+    if (registerNamespace) {
+      if (namespaceExists) {
+        revert WorldConsumer_NamespaceAlreadyExists(worldAddress, _namespace);
+      }
+      _world.registerNamespace(namespaceId);
+    } else if (!namespaceExists) {
+      revert WorldConsumer_NamespaceDoesNotExists(worldAddress, _namespace);
+    }
+  }
+
+  function _msgSender() public view virtual override returns (address sender) {
+    return _world() == msg.sender ? WorldContextConsumer._msgSender() : msg.sender;
+  }
+
+  function _msgValue() public view virtual override returns (uint256 value) {
+    address world = _world();
+    if (world != msg.sender) {
+      revert WorldConsumer_ValueNotAllowed(world);
+    }
+
+    return WorldContextConsumer._msgValue();
+  }
+}