@latticexyz/world-module-erc20 2.2.21-041031d271b62a7f41f7c6dc0098c1c0ae222bd5 → 2.2.21-581228bd857077023efdb496a9a44fa62ff89936

package/src/examples/ERC20PausableBurnable.sol

@@ -7,43 +7,30 @@ import { ResourceId } from "@latticexyz/store/src/ResourceId.sol";
 import { IBaseWorld } from "@latticexyz/world/src/codegen/interfaces/IBaseWorld.sol";
 import { WorldConsumer } from "@latticexyz/world-consumer/src/experimental/WorldConsumer.sol";
 
-import { Pausable } from "../experimental/Pausable.sol";
 import { ERC20Pausable } from "../experimental/ERC20Pausable.sol";
 import { ERC20Burnable } from "../experimental/ERC20Burnable.sol";
 import { MUDERC20 } from "../experimental/MUDERC20.sol";
 
 contract ERC20PausableBurnable is MUDERC20, ERC20Pausable, ERC20Burnable {
-  error ERC20PausableBurnable_AlreadyInitialized();
-
-  bytes14 private immutable _namespace;
-
   constructor(
     IBaseWorld world,
     bytes14 namespace,
-    ResourceId totalSupplyId,
-    ResourceId balancesId,
-    ResourceId allowancesId,
-    ResourceId metadataId,
-    ResourceId pausedId
-  ) WorldConsumer(world) MUDERC20(totalSupplyId, balancesId, allowancesId, metadataId) ERC20Pausable(pausedId) {
-    // Namespace used for access control
-    _namespace = namespace;
-  }
-
-  function initialize(string memory name, string memory symbol) external onlyNamespaceOwner(_namespace) {
-    _MUDERC20_init(name, symbol);
-    _Pausable_init();
+    string memory name,
+    string memory symbol
+  ) WorldConsumer(world, namespace, true) MUDERC20(name, symbol) {
+    // Transfer namespace ownership to the creator
+    world.transferOwnership(namespaceId, _msgSender());
   }
 
-  function mint(address to, uint256 value) public onlyNamespace(_namespace) {
+  function mint(address to, uint256 value) public onlyNamespace {
     _mint(to, value);
   }
 
-  function pause() public onlyNamespace(_namespace) {
+  function pause() public onlyNamespace {
     _pause();
   }
 
-  function unpause() public onlyNamespace(_namespace) {
+  function unpause() public onlyNamespace {
     _unpause();
   }
 

package/src/experimental/Constants.sol

@@ -27,6 +27,10 @@ library ERC20TableNames {
   bytes16 internal constant METADATA = "Metadata";
 }
 
+library OwnableTableNames {
+  bytes16 internal constant OWNER = "Owner";
+}
+
 library PausableTableNames {
   bytes16 internal constant PAUSED = "Paused";
 }

package/src/experimental/ERC20Module.sol

@@ -3,23 +3,16 @@ pragma solidity >=0.8.24;
 
 import { ResourceIds } from "@latticexyz/store/src/codegen/tables/ResourceIds.sol";
 import { ResourceId } from "@latticexyz/store/src/ResourceId.sol";
-import { RESOURCE_TABLE } from "@latticexyz/store/src/storeResourceTypes.sol";
 
 import { Module } from "@latticexyz/world/src/Module.sol";
 import { RESOURCE_SYSTEM } from "@latticexyz/world/src/worldResourceTypes.sol";
 import { WorldResourceIdLib } from "@latticexyz/world/src/WorldResourceId.sol";
 import { IBaseWorld } from "@latticexyz/world/src/codegen/interfaces/IBaseWorld.sol";
+import { revertWithBytes } from "@latticexyz/world/src/revertWithBytes.sol";
 
 import { ERC20Registry } from "../codegen/tables/ERC20Registry.sol";
 import { ERC20PausableBurnable } from "../examples/ERC20PausableBurnable.sol";
-import { MUDERC20 } from "../experimental/MUDERC20.sol";
-import { ModuleConstants, ERC20TableNames, PausableTableNames } from "./Constants.sol";
-
-import { ERC20Metadata, ERC20MetadataData } from "../codegen/tables/ERC20Metadata.sol";
-import { TotalSupply } from "../codegen/tables/TotalSupply.sol";
-import { Balances } from "../codegen/tables/Balances.sol";
-import { Allowances } from "../codegen/tables/Allowances.sol";
-import { Paused } from "../codegen/tables/Paused.sol";
+import { ModuleConstants } from "./Constants.sol";
 
 contract ERC20Module is Module {
   error ERC20Module_InvalidNamespace(bytes14 namespace);
@@ -46,53 +39,23 @@ contract ERC20Module is Module {
 
     IBaseWorld world = IBaseWorld(_world());
 
-    world.registerNamespace(namespaceId);
-
-    ERC20PausableBurnable token = ERC20ModuleLib.deployAndRegisterTables(world, namespace);
+    ERC20PausableBurnable token = new ERC20PausableBurnable(world, namespace, name, symbol);
 
-    // Grant access to the token so it can register and write to tables after transferring ownership
+    // Grant access to the token so it can write to tables after transferring ownership
     world.grantAccess(namespaceId, address(token));
 
     // Register token as a system so its functions can be called through the world
     world.registerSystem(systemId, token, true);
 
-    // Set metadata and paused state by calling initialize (onlyNamespaceOwner)
-    world.call(systemId, abi.encodeCall(ERC20PausableBurnable.initialize, (name, symbol)));
-
-    ERC20ModuleLib.registerToken(world, namespaceId, address(token));
-
+    // The token should have transferred the namespace ownership to this module in its constructor
     world.transferOwnership(namespaceId, _msgSender());
-  }
-}
-
-library ERC20ModuleLib {
-  function deployAndRegisterTables(IBaseWorld world, bytes14 namespace) public returns (ERC20PausableBurnable) {
-    ResourceId totalSupplyId = WorldResourceIdLib.encode(RESOURCE_TABLE, namespace, ERC20TableNames.TOTAL_SUPPLY);
-    ResourceId balancesId = WorldResourceIdLib.encode(RESOURCE_TABLE, namespace, ERC20TableNames.BALANCES);
-    ResourceId allowancesId = WorldResourceIdLib.encode(RESOURCE_TABLE, namespace, ERC20TableNames.ALLOWANCES);
-    ResourceId metadataId = WorldResourceIdLib.encode(RESOURCE_TABLE, namespace, ERC20TableNames.METADATA);
-    ResourceId pausedId = WorldResourceIdLib.encode(RESOURCE_TABLE, namespace, PausableTableNames.PAUSED);
 
-    // Register each table
-    TotalSupply.register(totalSupplyId);
-    Balances.register(balancesId);
-    Allowances.register(allowancesId);
-    ERC20Metadata.register(metadataId);
-    Paused.register(pausedId);
-
-    return
-      new ERC20PausableBurnable({
-        world: world,
-        namespace: namespace,
-        totalSupplyId: totalSupplyId,
-        balancesId: balancesId,
-        allowancesId: allowancesId,
-        metadataId: metadataId,
-        pausedId: pausedId
-      });
+    ERC20RegistryLib.register(world, namespaceId, address(token));
   }
+}
 
-  function registerToken(IBaseWorld world, ResourceId namespaceId, address token) public {
+library ERC20RegistryLib {
+  function register(IBaseWorld world, ResourceId namespaceId, address token) public {
     ResourceId erc20RegistryTableId = ModuleConstants.registryTableId();
     if (!ResourceIds.getExists(erc20RegistryTableId)) {
       world.registerNamespace(ModuleConstants.namespaceId());

package/src/experimental/ERC20Pausable.sol

@@ -2,13 +2,10 @@
 // Adapted from OpenZeppelin's [ERC20Pausable extenstion](https://github.com/OpenZeppelin/openzeppelin-contracts/blob/f989fff93168606c726bc5e831ef50dd6e543f45/contracts/token/ERC20/extensions/ERC20Pausable.sol)
 pragma solidity >=0.8.24;
 
-import { ResourceId } from "@latticexyz/store/src/ResourceId.sol";
 import { Pausable } from "./Pausable.sol";
 import { MUDERC20 } from "./MUDERC20.sol";
 
 abstract contract ERC20Pausable is MUDERC20, Pausable {
-  constructor(ResourceId pausedId) Pausable(pausedId) {}
-
   function _update(address from, address to, uint256 value) internal virtual override whenNotPaused {
     super._update(from, to, value);
   }

package/src/experimental/MUDERC20.sol

@@ -19,16 +19,25 @@ import { IERC20Errors } from "../interfaces/IERC20Errors.sol";
 import { ERC20TableNames } from "./Constants.sol";
 
 abstract contract MUDERC20 is IERC20, IERC20Metadata, IERC20Errors, WorldConsumer {
-  ResourceId private immutable _totalSupplyId;
-  ResourceId private immutable _balancesId;
-  ResourceId private immutable _allowancesId;
-  ResourceId private immutable _metadataId;
-
-  constructor(ResourceId totalSupplyId, ResourceId balancesId, ResourceId allowancesId, ResourceId metadataId) {
-    _totalSupplyId = totalSupplyId;
-    _balancesId = balancesId;
-    _allowancesId = allowancesId;
-    _metadataId = metadataId;
+  ResourceId internal immutable totalSupplyId;
+  ResourceId internal immutable balancesId;
+  ResourceId internal immutable allowancesId;
+  ResourceId internal immutable metadataId;
+
+  constructor(string memory _name, string memory _symbol) {
+    // Needs to be inlined in the constructor
+    totalSupplyId = WorldResourceIdLib.encode(RESOURCE_TABLE, namespace, ERC20TableNames.TOTAL_SUPPLY);
+    balancesId = WorldResourceIdLib.encode(RESOURCE_TABLE, namespace, ERC20TableNames.BALANCES);
+    allowancesId = WorldResourceIdLib.encode(RESOURCE_TABLE, namespace, ERC20TableNames.ALLOWANCES);
+    metadataId = WorldResourceIdLib.encode(RESOURCE_TABLE, namespace, ERC20TableNames.METADATA);
+
+    // Register each table
+    TotalSupply.register(totalSupplyId);
+    Balances.register(balancesId);
+    Allowances.register(allowancesId);
+    ERC20Metadata.register(metadataId);
+
+    _setMetadata(_name, _symbol, 18);
   }
 
   /**
@@ -144,10 +153,6 @@ abstract contract MUDERC20 is IERC20, IERC20Metadata, IERC20Errors, WorldConsume
     return true;
   }
 
-  function _MUDERC20_init(string memory _name, string memory _symbol) internal {
-    _setMetadata(_name, _symbol, 18);
-  }
-
   /**
    * @dev Creates a `value` amount of tokens and assigns them to `account`, by transferring it from address(0).
    * Relies on the `_update` mechanism
@@ -279,43 +284,43 @@ abstract contract MUDERC20 is IERC20, IERC20Metadata, IERC20Errors, WorldConsume
   }
 
   function _getName() internal view returns (string memory) {
-    return ERC20Metadata.getName(_metadataId);
+    return ERC20Metadata.getName(metadataId);
   }
 
   function _getSymbol() internal view returns (string memory) {
-    return ERC20Metadata.getSymbol(_metadataId);
+    return ERC20Metadata.getSymbol(metadataId);
   }
 
   function _getDecimals() internal view returns (uint8) {
-    return ERC20Metadata.getDecimals(_metadataId);
+    return ERC20Metadata.getDecimals(metadataId);
   }
 
   function _getTotalSupply() internal view returns (uint256) {
-    return TotalSupply.get(_totalSupplyId);
+    return TotalSupply.get(totalSupplyId);
   }
 
   function _getBalance(address account) internal view returns (uint256) {
-    return Balances.get(_balancesId, account);
+    return Balances.get(balancesId, account);
   }
 
   function _getAllowance(address owner, address spender) internal view returns (uint256) {
-    return Allowances.get(_allowancesId, owner, spender);
+    return Allowances.get(allowancesId, owner, spender);
   }
 
   function _setTotalSupply(uint256 value) internal virtual {
-    TotalSupply.set(_totalSupplyId, value);
+    TotalSupply.set(totalSupplyId, value);
   }
 
   function _setBalance(address account, uint256 value) internal virtual {
-    Balances.set(_balancesId, account, value);
+    Balances.set(balancesId, account, value);
   }
 
   function _setAllowance(address owner, address spender, uint256 value) internal virtual {
-    Allowances.set(_allowancesId, owner, spender, value);
+    Allowances.set(allowancesId, owner, spender, value);
   }
 
   function _setMetadata(string memory _name, string memory _symbol, uint8 _decimals) internal virtual {
     ERC20MetadataData memory metadata = ERC20MetadataData(_decimals, _name, _symbol);
-    ERC20Metadata.set(_metadataId, metadata);
+    ERC20Metadata.set(metadataId, metadata);
   }
 }

package/src/experimental/Pausable.sol

@@ -2,11 +2,13 @@
 // Adapted from OpenZeppelin Contracts [utils/Pausable.sol](https://github.com/OpenZeppelin/openzeppelin-contracts/blob/f989fff93168606c726bc5e831ef50dd6e543f45/contracts/utils/Pausable.sol)
 pragma solidity >=0.8.24;
 
+import { RESOURCE_TABLE } from "@latticexyz/store/src/storeResourceTypes.sol";
 import { ResourceId } from "@latticexyz/store/src/ResourceId.sol";
 import { WorldResourceIdLib } from "@latticexyz/world/src/WorldResourceId.sol";
 import { WorldConsumer } from "@latticexyz/world-consumer/src/experimental/WorldConsumer.sol";
 
 import { Paused as PausedTable } from "../codegen/tables/Paused.sol";
+import { PausableTableNames } from "./Constants.sol";
 
 /**
  * @dev Contract module which allows children to implement an emergency stop
@@ -18,7 +20,7 @@ import { Paused as PausedTable } from "../codegen/tables/Paused.sol";
  * simply including this module, only once the modifiers are put in place.
  */
 abstract contract Pausable is WorldConsumer {
-  ResourceId private immutable _pausedId;
+  ResourceId internal immutable pausedId;
 
   /**
    * @dev Emitted when the pause is triggered by `account`.
@@ -40,6 +42,15 @@ abstract contract Pausable is WorldConsumer {
    */
   error ExpectedPause();
 
+  /**
+   * @dev Initializes the contract in unpaused state.
+   */
+  constructor() {
+    pausedId = WorldResourceIdLib.encode(RESOURCE_TABLE, namespace, PausableTableNames.PAUSED);
+    PausedTable.register(pausedId);
+    PausedTable.set(pausedId, false);
+  }
+
   /**
    * @dev Modifier to make a function callable only when the contract is not paused.
    *
@@ -64,22 +75,11 @@ abstract contract Pausable is WorldConsumer {
     _;
   }
 
-  constructor(ResourceId pausedId) {
-    _pausedId = pausedId;
-  }
-
-  /**
-   * @dev Initializes the contract in unpaused state.
-   */
-  function _Pausable_init() internal {
-    PausedTable.set(_pausedId, false);
-  }
-
   /**
    * @dev Returns true if the contract is paused, and false otherwise.
    */
   function paused() public view virtual returns (bool) {
-    return PausedTable.get(_pausedId);
+    return PausedTable.get(pausedId);
   }
 
   /**
@@ -108,7 +108,7 @@ abstract contract Pausable is WorldConsumer {
    * - The contract must not be paused.
    */
   function _pause() internal virtual whenNotPaused {
-    PausedTable.set(_pausedId, true);
+    PausedTable.set(pausedId, true);
     emit Paused(_msgSender());
   }
 
@@ -120,7 +120,7 @@ abstract contract Pausable is WorldConsumer {
    * - The contract must be paused.
    */
   function _unpause() internal virtual whenPaused {
-    PausedTable.set(_pausedId, false);
+    PausedTable.set(pausedId, false);
     emit Unpaused(_msgSender());
   }
 }