feat(modules): standalone erc20 with external store

packages/store/test/StoreMock.sol

@@ -1,16 +1,17 @@
 // SPDX-License-Identifier: MIT
 pragma solidity >=0.8.24;
 
-import { IStore } from "../src/IStore.sol";
-import { IStoreHook } from "../src/IStoreHook.sol";
-import { StoreSwitch } from "../src/StoreSwitch.sol";
 import { Store } from "../src/Store.sol";
-import { EncodedLengths } from "../src/EncodedLengths.sol";
-import { StoreCore } from "../src/StoreCore.sol";
 import { Schema } from "../src/Schema.sol";
-import { FieldLayout } from "../src/FieldLayout.sol";
+import { IStore } from "../src/IStore.sol";
 import { StoreRead } from "../src/StoreRead.sol";
+import { StoreCore } from "../src/StoreCore.sol";
+import { IStoreRead } from "../src/IStoreRead.sol";
 import { ResourceId } from "../src/ResourceId.sol";
+import { IStoreHook } from "../src/IStoreHook.sol";
+import { StoreSwitch } from "../src/StoreSwitch.sol";
+import { FieldLayout } from "../src/FieldLayout.sol";
+import { EncodedLengths } from "../src/EncodedLengths.sol";
 
 /**
  * StoreMock is a contract wrapper around the StoreCore library for testing purposes.
@@ -87,6 +88,23 @@ contract StoreMock is Store {
     StoreCore.setStaticField(tableId, keyTuple, fieldIndex, data, fieldLayout);
   }
 
+  /**
+   * @notice Retrieves data for a specific static (fixed length) field in a record.
+   * @param tableId The ID of the table.
+   * @param keyTuple The tuple used as a key to fetch the static field.
+   * @param fieldIndex Index of the static field to retrieve.
+   * @param fieldLayout The layout of fields for the retrieval.
+   * @return data The static data of the specified field.
+   */
+  function getStaticField(
+    ResourceId tableId,
+    bytes32[] calldata keyTuple,
+    uint8 fieldIndex,
+    FieldLayout fieldLayout
+  ) public view virtual override(IStoreRead, StoreRead) returns (bytes32 data) {
+    data = StoreCore.getStaticField(tableId, keyTuple, fieldIndex, fieldLayout);
+  }
+
   // Set partial data at dynamic field index
   function setDynamicField(
     ResourceId tableId,
@@ -117,6 +135,21 @@ contract StoreMock is Store {
     StoreCore.popFromDynamicField(tableId, keyTuple, dynamicFieldIndex, byteLengthToPop);
   }
 
+  /**
+   * @notice Retrieves data for a specific dynamic (variable length) field in a record.
+   * @param tableId The ID of the table.
+   * @param keyTuple The tuple used as a key to fetch the dynamic field.
+   * @param dynamicFieldIndex Index of the dynamic field to retrieve.
+   * @return data The dynamic data of the specified field.
+   */
+  function getDynamicField(
+    ResourceId tableId,
+    bytes32[] calldata keyTuple,
+    uint8 dynamicFieldIndex
+  ) public view virtual override(IStoreRead, StoreRead) returns (bytes memory data) {
+    data = StoreCore.getDynamicField(tableId, keyTuple, dynamicFieldIndex);
+  }
+
   // Set full record (including full dynamic data)
   function deleteRecord(ResourceId tableId, bytes32[] memory keyTuple) public virtual {
     StoreCore.deleteRecord(tableId, keyTuple);

packages/world-module-erc20-external-store/.changeset/README.md

@@ -0,0 +1,8 @@
+# Changesets
+
+Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
+with multi-package repos, or single-package repos to help you version and publish your code. You can
+find the full documentation for it [in our repository](https://github.com/changesets/changesets)
+
+We have a quick list of common questions to get you started engaging with this project in
+[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

packages/world-module-erc20-external-store/.changeset/chilled-beds-listen.md

@@ -0,0 +1,5 @@
+---
+"@latticexyz/world-module-erc20-external-store": major
+---
+
+Add erc20 module with external store

packages/world-module-erc20-external-store/.changeset/config.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://unpkg.com/@changesets/[email protected]/schema.json",
+  "changelog": "@changesets/cli/changelog",
+  "commit": false,
+  "fixed": [],
+  "linked": [],
+  "access": "restricted",
+  "baseBranch": "main",
+  "updateInternalDependencies": "patch",
+  "ignore": []
+}

packages/world-module-erc20-external-store/.gitignore

@@ -0,0 +1,3 @@
+cache
+out
+src/codegen/world/

packages/world-module-erc20-external-store/.solhint.json

@@ -0,0 +1,8 @@
+{
+  "extends": "solhint:recommended",
+  "rules": {
+    "compiler-version": ["error", ">=0.8.0"],
+    "avoid-low-level-calls": "off",
+    "func-visibility": ["warn", { "ignoreConstructors": true }]
+  }
+}

packages/world-module-erc20-external-store/README.md

@@ -0,0 +1,5 @@
+# Standalone ERC20 Module with external Store
+
+This is an `ERC20` token template that is compatible with the MUD framework. The logic of the token contract is near native and resides within the token contract, while its storage makes use of `Store` and is reflected in corresponding tables.
+
+The `OpenZeppelin` implementation of ERC20 is used as reference but tests are written in `Solidity`.

packages/world-module-erc20-external-store/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/world-module-erc20-external-store/gas-report.json

@@ -0,0 +1,170 @@
+[
+  {
+    "file": "test/ERC20.t.sol",
+    "test": "testApprove",
+    "name": "token constructor",
+    "gasUsed": 8474513
+  },
+  {
+    "file": "test/ERC20.t.sol",
+    "test": "testApprove",
+    "name": "token approve",
+    "gasUsed": 70155
+  },
+  {
+    "file": "test/ERC20.t.sol",
+    "test": "testBalanceOf",
+    "name": "token constructor",
+    "gasUsed": 8474513
+  },
+  {
+    "file": "test/ERC20.t.sol",
+    "test": "testBalanceOf",
+    "name": "token constructor",
+    "gasUsed": 8474513
+  },
+  {
+    "file": "test/ERC20.t.sol",
+    "test": "testBalanceOf",
+    "name": "token constructor",
+    "gasUsed": 8474513
+  },
+  {
+    "file": "test/ERC20.t.sol",
+    "test": "testBalanceOf",
+    "name": "token constructor",
+    "gasUsed": 8474513
+  },
+  {
+    "file": "test/ERC20.t.sol",
+    "test": "testBalanceOf",
+    "name": "token constructor",
+    "gasUsed": 8474513
+  },
+  {
+    "file": "test/ERC20.t.sol",
+    "test": "testTokenBurn",
+    "name": "token constructor",
+    "gasUsed": 8474513
+  },
+  {
+    "file": "test/ERC20.t.sol",
+    "test": "testTokenBurn",
+    "name": "token burn",
+    "gasUsed": 79906
+  },
+  {
+    "file": "test/ERC20.t.sol",
+    "test": "testTokenBurnInvalidCaller",
+    "name": "token constructor",
+    "gasUsed": 8474513
+  },
+  {
+    "file": "test/ERC20.t.sol",
+    "test": "testTokenBurnInvalidCaller",
+    "name": "token burn invalid caller",
+    "gasUsed": 38433
+  },
+  {
+    "file": "test/ERC20.t.sol",
+    "test": "testTokenBurnZeroAddress",
+    "name": "token constructor",
+    "gasUsed": 8474513
+  },
+  {
+    "file": "test/ERC20.t.sol",
+    "test": "testTokenBurnZeroAddress",
+    "name": "token burn zero address",
+    "gasUsed": 38348
+  },
+  {
+    "file": "test/ERC20.t.sol",
+    "test": "testTokenMint",
+    "name": "token constructor",
+    "gasUsed": 8474513
+  },
+  {
+    "file": "test/ERC20.t.sol",
+    "test": "testTokenMint",
+    "name": "token mint",
+    "gasUsed": 101554
+  },
+  {
+    "file": "test/ERC20.t.sol",
+    "test": "testTokenMintInvalidCaller",
+    "name": "token constructor",
+    "gasUsed": 8474513
+  },
+  {
+    "file": "test/ERC20.t.sol",
+    "test": "testTokenMintInvalidCaller",
+    "name": "token mint invalid caller",
+    "gasUsed": 38434
+  },
+  {
+    "file": "test/ERC20.t.sol",
+    "test": "testTokenMintToZeroAddress",
+    "name": "token constructor",
+    "gasUsed": 8474513
+  },
+  {
+    "file": "test/ERC20.t.sol",
+    "test": "testTokenMintToZeroAddress",
+    "name": "token mint to zero address",
+    "gasUsed": 38349
+  },
+  {
+    "file": "test/ERC20.t.sol",
+    "test": "testTokenSetUp",
+    "name": "token constructor",
+    "gasUsed": 8474513
+  },
+  {
+    "file": "test/ERC20.t.sol",
+    "test": "testTokenTransfer",
+    "name": "token constructor",
+    "gasUsed": 8474513
+  },
+  {
+    "file": "test/ERC20.t.sol",
+    "test": "testTokenTransfer",
+    "name": "token transfer",
+    "gasUsed": 86103
+  },
+  {
+    "file": "test/ERC20.t.sol",
+    "test": "testTokenTransferInsufficientBalance",
+    "name": "token constructor",
+    "gasUsed": 8474513
+  },
+  {
+    "file": "test/ERC20.t.sol",
+    "test": "testTokenTransferInsufficientBalance",
+    "name": "token transfer insufficient balance",
+    "gasUsed": 34297
+  },
+  {
+    "file": "test/ERC20.t.sol",
+    "test": "testTransferFrom",
+    "name": "token constructor",
+    "gasUsed": 8474513
+  },
+  {
+    "file": "test/ERC20.t.sol",
+    "test": "testTransferFrom",
+    "name": "token transferFrom",
+    "gasUsed": 102755
+  },
+  {
+    "file": "test/ERC20.t.sol",
+    "test": "testTransferFromInsufficientAllowance",
+    "name": "token constructor",
+    "gasUsed": 8474513
+  },
+  {
+    "file": "test/ERC20.t.sol",
+    "test": "testTransferFromInsufficientAllowance",
+    "name": "token transferFrom insufficient allowance",
+    "gasUsed": 36861
+  }
+]

packages/world-module-erc20-external-store/mud.config.ts

@@ -0,0 +1,38 @@
+import { defineWorld } from "@latticexyz/world";
+
+export default defineWorld({
+  namespace: "erc20-store",
+  tables: {
+    Token: {
+      schema: {
+        decimals: "uint8",
+        totalSupply: "uint256",
+        owner: "address",
+        name: "string",
+        symbol: "string",
+      },
+      key: [],
+      codegen: {
+        tableIdArgument: true,
+        storeArgument: true,
+      },
+    },
+    Balances: {
+      schema: {
+        tokenAddress: "address",
+        account: "address",
+        balance: "uint256",
+      },
+      key: ["tokenAddress", "account"],
+    },
+    Allowances: {
+      schema: {
+        tokenAddress: "address",
+        account: "address",
+        spender: "address",
+        approval: "uint256",
+      },
+      key: ["tokenAddress", "account", "spender"],
+    },
+  },
+});

packages/world-module-erc20-external-store/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@latticexyz/world-module-erc20-external-store",
+  "version": "2.1.1",
+  "description": "ERC20 World Module with External Store",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/latticexyz/mud.git",
+    "directory": "packages/world-module-erc20-own-store"
+  },
+  "license": "MIT",
+  "type": "module",
+  "exports": {
+    "./mud.config": "./dist/mud.config.js",
+    "./out/*": "./out/*"
+  },
+  "typesVersions": {
+    "*": {
+      "mud.config": [
+        "./dist/mud.config.d.ts"
+      ]
+    }
+  },
+  "files": [
+    "dist",
+    "out",
+    "src"
+  ],
+  "scripts": {
+    "build": "mud build",
+    "clean": "forge clean && shx rm -rf src/**/codegen",
+    "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/cli": "workspace:*",
+    "@latticexyz/gas-report": "workspace:*",
+    "@types/node": "^18.15.11",
+    "ds-test": "https://github.com/dapphub/ds-test.git#e282159d5170298eb2455a6c05280ab5a73a4ef0",
+    "forge-std": "https://github.com/foundry-rs/forge-std.git#74cfb77e308dd188d2f58864aaf44963ae6b88b1",
+    "solhint": "^3.3.7",
+    "tsup": "^6.7.0",
+    "tsx": "^3.12.6",
+    "vitest": "0.34.6"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}