@latticexyz/world-module-erc20 2.2.13-entrykit-0124fe749bead05228687a1b929463b7da909d59

package/src/codegen/tables/TotalSupply.sol

@@ -0,0 +1,184 @@
+// SPDX-License-Identifier: MIT
+pragma solidity >=0.8.24;
+
+/* Autogenerated file. Do not edit manually. */
+
+// Import store internals
+import { IStore } from "@latticexyz/store/src/IStore.sol";
+import { StoreSwitch } from "@latticexyz/store/src/StoreSwitch.sol";
+import { StoreCore } from "@latticexyz/store/src/StoreCore.sol";
+import { Bytes } from "@latticexyz/store/src/Bytes.sol";
+import { Memory } from "@latticexyz/store/src/Memory.sol";
+import { SliceLib } from "@latticexyz/store/src/Slice.sol";
+import { EncodeArray } from "@latticexyz/store/src/tightcoder/EncodeArray.sol";
+import { FieldLayout } from "@latticexyz/store/src/FieldLayout.sol";
+import { Schema } from "@latticexyz/store/src/Schema.sol";
+import { EncodedLengths, EncodedLengthsLib } from "@latticexyz/store/src/EncodedLengths.sol";
+import { ResourceId } from "@latticexyz/store/src/ResourceId.sol";
+
+library TotalSupply {
+  FieldLayout constant _fieldLayout =
+    FieldLayout.wrap(0x0020010020000000000000000000000000000000000000000000000000000000);
+
+  // Hex-encoded key schema of ()
+  Schema constant _keySchema = Schema.wrap(0x0000000000000000000000000000000000000000000000000000000000000000);
+  // Hex-encoded value schema of (uint256)
+  Schema constant _valueSchema = Schema.wrap(0x002001001f000000000000000000000000000000000000000000000000000000);
+
+  /**
+   * @notice Get the table's key field names.
+   * @return keyNames An array of strings with the names of key fields.
+   */
+  function getKeyNames() internal pure returns (string[] memory keyNames) {
+    keyNames = new string[](0);
+  }
+
+  /**
+   * @notice Get the table's value field names.
+   * @return fieldNames An array of strings with the names of value fields.
+   */
+  function getFieldNames() internal pure returns (string[] memory fieldNames) {
+    fieldNames = new string[](1);
+    fieldNames[0] = "totalSupply";
+  }
+
+  /**
+   * @notice Register the table with its config.
+   */
+  function register(ResourceId _tableId) internal {
+    StoreSwitch.registerTable(_tableId, _fieldLayout, _keySchema, _valueSchema, getKeyNames(), getFieldNames());
+  }
+
+  /**
+   * @notice Register the table with its config.
+   */
+  function _register(ResourceId _tableId) internal {
+    StoreCore.registerTable(_tableId, _fieldLayout, _keySchema, _valueSchema, getKeyNames(), getFieldNames());
+  }
+
+  /**
+   * @notice Get totalSupply.
+   */
+  function getTotalSupply(ResourceId _tableId) internal view returns (uint256 totalSupply) {
+    bytes32[] memory _keyTuple = new bytes32[](0);
+
+    bytes32 _blob = StoreSwitch.getStaticField(_tableId, _keyTuple, 0, _fieldLayout);
+    return (uint256(bytes32(_blob)));
+  }
+
+  /**
+   * @notice Get totalSupply.
+   */
+  function _getTotalSupply(ResourceId _tableId) internal view returns (uint256 totalSupply) {
+    bytes32[] memory _keyTuple = new bytes32[](0);
+
+    bytes32 _blob = StoreCore.getStaticField(_tableId, _keyTuple, 0, _fieldLayout);
+    return (uint256(bytes32(_blob)));
+  }
+
+  /**
+   * @notice Get totalSupply.
+   */
+  function get(ResourceId _tableId) internal view returns (uint256 totalSupply) {
+    bytes32[] memory _keyTuple = new bytes32[](0);
+
+    bytes32 _blob = StoreSwitch.getStaticField(_tableId, _keyTuple, 0, _fieldLayout);
+    return (uint256(bytes32(_blob)));
+  }
+
+  /**
+   * @notice Get totalSupply.
+   */
+  function _get(ResourceId _tableId) internal view returns (uint256 totalSupply) {
+    bytes32[] memory _keyTuple = new bytes32[](0);
+
+    bytes32 _blob = StoreCore.getStaticField(_tableId, _keyTuple, 0, _fieldLayout);
+    return (uint256(bytes32(_blob)));
+  }
+
+  /**
+   * @notice Set totalSupply.
+   */
+  function setTotalSupply(ResourceId _tableId, uint256 totalSupply) internal {
+    bytes32[] memory _keyTuple = new bytes32[](0);
+
+    StoreSwitch.setStaticField(_tableId, _keyTuple, 0, abi.encodePacked((totalSupply)), _fieldLayout);
+  }
+
+  /**
+   * @notice Set totalSupply.
+   */
+  function _setTotalSupply(ResourceId _tableId, uint256 totalSupply) internal {
+    bytes32[] memory _keyTuple = new bytes32[](0);
+
+    StoreCore.setStaticField(_tableId, _keyTuple, 0, abi.encodePacked((totalSupply)), _fieldLayout);
+  }
+
+  /**
+   * @notice Set totalSupply.
+   */
+  function set(ResourceId _tableId, uint256 totalSupply) internal {
+    bytes32[] memory _keyTuple = new bytes32[](0);
+
+    StoreSwitch.setStaticField(_tableId, _keyTuple, 0, abi.encodePacked((totalSupply)), _fieldLayout);
+  }
+
+  /**
+   * @notice Set totalSupply.
+   */
+  function _set(ResourceId _tableId, uint256 totalSupply) internal {
+    bytes32[] memory _keyTuple = new bytes32[](0);
+
+    StoreCore.setStaticField(_tableId, _keyTuple, 0, abi.encodePacked((totalSupply)), _fieldLayout);
+  }
+
+  /**
+   * @notice Delete all data for given keys.
+   */
+  function deleteRecord(ResourceId _tableId) internal {
+    bytes32[] memory _keyTuple = new bytes32[](0);
+
+    StoreSwitch.deleteRecord(_tableId, _keyTuple);
+  }
+
+  /**
+   * @notice Delete all data for given keys.
+   */
+  function _deleteRecord(ResourceId _tableId) internal {
+    bytes32[] memory _keyTuple = new bytes32[](0);
+
+    StoreCore.deleteRecord(_tableId, _keyTuple, _fieldLayout);
+  }
+
+  /**
+   * @notice Tightly pack static (fixed length) data using this table's schema.
+   * @return The static data, encoded into a sequence of bytes.
+   */
+  function encodeStatic(uint256 totalSupply) internal pure returns (bytes memory) {
+    return abi.encodePacked(totalSupply);
+  }
+
+  /**
+   * @notice Encode all of a record's fields.
+   * @return The static (fixed length) data, encoded into a sequence of bytes.
+   * @return The lengths of the dynamic fields (packed into a single bytes32 value).
+   * @return The dynamic (variable length) data, encoded into a sequence of bytes.
+   */
+  function encode(uint256 totalSupply) internal pure returns (bytes memory, EncodedLengths, bytes memory) {
+    bytes memory _staticData = encodeStatic(totalSupply);
+
+    EncodedLengths _encodedLengths;
+    bytes memory _dynamicData;
+
+    return (_staticData, _encodedLengths, _dynamicData);
+  }
+
+  /**
+   * @notice Encode keys as a bytes32 array using this table's field layout.
+   */
+  function encodeKeyTuple() internal pure returns (bytes32[] memory) {
+    bytes32[] memory _keyTuple = new bytes32[](0);
+
+    return _keyTuple;
+  }
+}

package/src/examples/ERC20WithInternalStore.sol

@@ -0,0 +1,32 @@
+// SPDX-License-Identifier: MIT
+pragma solidity >=0.8.24;
+
+// Adapted example from OpenZeppelin's Contract Wizard: https://wizard.openzeppelin.com/
+
+import { WithStore } from "../WithStore.sol";
+import { Ownable } from "../Ownable.sol";
+import { ERC20Pausable } from "../ERC20Pausable.sol";
+import { ERC20Burnable } from "../ERC20Burnable.sol";
+import { MUDERC20 } from "../MUDERC20.sol";
+
+contract ERC20WithInternalStore is WithStore(address(this)), MUDERC20, ERC20Pausable, ERC20Burnable, Ownable {
+  constructor() MUDERC20("MyERC20", "MTK") Ownable(_msgSender()) {}
+
+  function mint(address to, uint256 value) public onlyOwner {
+    _mint(to, value);
+  }
+
+  function pause() public onlyOwner {
+    _pause();
+  }
+
+  function unpause() public onlyOwner {
+    _unpause();
+  }
+
+  // The following functions are overrides required by Solidity.
+
+  function _update(address from, address to, uint256 value) internal override(MUDERC20, ERC20Pausable) {
+    super._update(from, to, value);
+  }
+}

package/src/examples/ERC20WithWorld.sol

@@ -0,0 +1,40 @@
+// SPDX-License-Identifier: MIT
+pragma solidity >=0.8.24;
+
+// Adapted example from OpenZeppelin's Contract Wizard: https://wizard.openzeppelin.com/
+
+import { IBaseWorld } from "@latticexyz/world/src/codegen/interfaces/IBaseWorld.sol";
+import { WithWorld } from "../WithWorld.sol";
+import { ERC20Pausable } from "../ERC20Pausable.sol";
+import { ERC20Burnable } from "../ERC20Burnable.sol";
+import { MUDERC20 } from "../MUDERC20.sol";
+
+contract ERC20WithWorld is WithWorld, MUDERC20, ERC20Pausable, ERC20Burnable {
+  constructor(
+    IBaseWorld world,
+    bytes14 namespace,
+    string memory name,
+    string memory symbol
+  ) WithWorld(world, namespace) MUDERC20(name, symbol) {
+    // Transfer namespace ownership to the creator
+    world.transferOwnership(getNamespaceId(), _msgSender());
+  }
+
+  function mint(address to, uint256 value) public onlyNamespace {
+    _mint(to, value);
+  }
+
+  function pause() public onlyNamespace {
+    _pause();
+  }
+
+  function unpause() public onlyNamespace {
+    _unpause();
+  }
+
+  // The following functions are overrides required by Solidity.
+
+  function _update(address from, address to, uint256 value) internal override(MUDERC20, ERC20Pausable) {
+    super._update(from, to, value);
+  }
+}

package/src/interfaces/IERC20.sol

@@ -0,0 +1,67 @@
+// SPDX-License-Identifier: MIT
+// OpenZeppelin Contracts (last updated v5.0.0) (token/ERC20/IERC20.sol)
+
+pragma solidity >=0.8.24;
+
+import { IERC20Events } from "./IERC20Events.sol";
+
+/**
+ * @dev Interface of the ERC20 standard as defined in the EIP.
+ */
+interface IERC20 is IERC20Events {
+  /**
+   * @dev Returns the value of tokens in existence.
+   */
+  function totalSupply() external view returns (uint256);
+
+  /**
+   * @dev Returns the value of tokens owned by `account`.
+   */
+  function balanceOf(address account) external view returns (uint256);
+
+  /**
+   * @dev Moves a `value` amount of tokens from the caller's account to `to`.
+   *
+   * Returns a boolean value indicating whether the operation succeeded.
+   *
+   * Emits a {Transfer} event.
+   */
+  function transfer(address to, uint256 value) external returns (bool);
+
+  /**
+   * @dev Returns the remaining number of tokens that `spender` will be
+   * allowed to spend on behalf of `owner` through {transferFrom}. This is
+   * zero by default.
+   *
+   * This value changes when {approve} or {transferFrom} are called.
+   */
+  function allowance(address owner, address spender) external view returns (uint256);
+
+  /**
+   * @dev Sets a `value` amount of tokens as the allowance of `spender` over the
+   * caller's tokens.
+   *
+   * Returns a boolean value indicating whether the operation succeeded.
+   *
+   * IMPORTANT: Beware that changing an allowance with this method brings the risk
+   * that someone may use both the old and the new allowance by unfortunate
+   * transaction ordering. One possible solution to mitigate this race
+   * condition is to first reduce the spender's allowance to 0 and set the
+   * desired value afterwards:
+   * https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729
+   *
+   * Emits an {Approval} event.
+   */
+  function approve(address spender, uint256 value) external returns (bool);
+
+  /**
+   * @dev Moves a `value` amount of tokens from `from` to `to` using the
+   * allowance mechanism. `value` is then deducted from the caller's
+   * allowance.
+   *
+   * Returns a boolean value indicating whether the operation succeeded.
+   *
+   * Emits a {Transfer} event.
+   */
+  function transferFrom(address from, address to, uint256 value) external returns (bool);
+}

package/src/interfaces/IERC20Errors.sol

@@ -0,0 +1,49 @@
+// SPDX-License-Identifier: MIT
+// OpenZeppelin Contracts (last updated v5.0.0) (interfaces/draft-IERC6093.sol)
+pragma solidity >=0.8.24;
+
+/**
+ * @dev Standard ERC20 Errors
+ * Interface of the https://eips.ethereum.org/EIPS/eip-6093[ERC-6093] custom errors for ERC20 tokens.
+ */
+interface IERC20Errors {
+  /**
+   * @dev Indicates an error related to the current `balance` of a `sender`. Used in transfers.
+   * @param sender Address whose tokens are being transferred.
+   * @param balance Current balance for the interacting account.
+   * @param needed Minimum amount required to perform a transfer.
+   */
+  error ERC20InsufficientBalance(address sender, uint256 balance, uint256 needed);
+
+  /**
+   * @dev Indicates a failure with the token `sender`. Used in transfers.
+   * @param sender Address whose tokens are being transferred.
+   */
+  error ERC20InvalidSender(address sender);
+
+  /**
+   * @dev Indicates a failure with the token `receiver`. Used in transfers.
+   * @param receiver Address to which tokens are being transferred.
+   */
+  error ERC20InvalidReceiver(address receiver);
+
+  /**
+   * @dev Indicates a failure with the `spender`’s `allowance`. Used in transfers.
+   * @param spender Address that may be allowed to operate on tokens without being their owner.
+   * @param allowance Amount of tokens a `spender` is allowed to operate with.
+   * @param needed Minimum amount required to perform a transfer.
+   */
+  error ERC20InsufficientAllowance(address spender, uint256 allowance, uint256 needed);
+
+  /**
+   * @dev Indicates a failure with the `approver` of a token to be approved. Used in approvals.
+   * @param approver Address initiating an approval operation.
+   */
+  error ERC20InvalidApprover(address approver);
+
+  /**
+   * @dev Indicates a failure with the `spender` to be approved. Used in approvals.
+   * @param spender Address that may be allowed to operate on tokens without being their owner.
+   */
+  error ERC20InvalidSpender(address spender);
+}

package/src/interfaces/IERC20Events.sol

@@ -0,0 +1,18 @@
+// SPDX-License-Identifier: MIT
+pragma solidity >=0.8.24;
+
+interface IERC20Events {
+  /**
+   * @dev Emitted when `value` tokens are moved from one account (`from`) to
+   * another (`to`).
+   *
+   * Note that `value` may be zero.
+   */
+  event Transfer(address indexed from, address indexed to, uint256 value);
+
+  /**
+   * @dev Emitted when the allowance of a `spender` for an `owner` is set by
+   * a call to {approve}. `value` is the new allowance.
+   */
+  event Approval(address indexed owner, address indexed spender, uint256 value);
+}

package/src/interfaces/IERC20Metadata.sol

@@ -0,0 +1,26 @@
+// SPDX-License-Identifier: MIT
+// OpenZeppelin Contracts (last updated v5.0.0) (token/ERC20/extensions/IERC20Metadata.sol)
+
+pragma solidity ^0.8.20;
+
+import { IERC20 } from "./IERC20.sol";
+
+/**
+ * @dev Interface for the optional metadata functions from the ERC-20 standard.
+ */
+interface IERC20Metadata is IERC20 {
+  /**
+   * @dev Returns the name of the token.
+   */
+  function name() external view returns (string memory);
+
+  /**
+   * @dev Returns the symbol of the token.
+   */
+  function symbol() external view returns (string memory);
+
+  /**
+   * @dev Returns the decimals places of the token.
+   */
+  function decimals() external view returns (uint8);
+}