feat(modules): standalone erc20 with own store

packages/world-module-erc20-own-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-own-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-own-store/.changeset/thirty-wasps-flow.md

@@ -0,0 +1,5 @@
+---
+"@latticexyz/world-module-erc20-own-store": major
+---
+
+Implement ERC20 Module with own Store

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

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

packages/world-module-erc20-own-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-own-store/README.md

@@ -0,0 +1,5 @@
+# Standalone ERC20 Module with own 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-own-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-own-store/gas-report.json

@@ -0,0 +1,170 @@
+[
+  {
+    "file": "test/ERC20.t.sol",
+    "test": "testApprove",
+    "name": "token constructor",
+    "gasUsed": 7686226
+  },
+  {
+    "file": "test/ERC20.t.sol",
+    "test": "testApprove",
+    "name": "token approve",
+    "gasUsed": 64807
+  },
+  {
+    "file": "test/ERC20.t.sol",
+    "test": "testBalanceOf",
+    "name": "token constructor",
+    "gasUsed": 7686226
+  },
+  {
+    "file": "test/ERC20.t.sol",
+    "test": "testBalanceOf",
+    "name": "token constructor",
+    "gasUsed": 7686226
+  },
+  {
+    "file": "test/ERC20.t.sol",
+    "test": "testBalanceOf",
+    "name": "token constructor",
+    "gasUsed": 7686226
+  },
+  {
+    "file": "test/ERC20.t.sol",
+    "test": "testBalanceOf",
+    "name": "token constructor",
+    "gasUsed": 7686226
+  },
+  {
+    "file": "test/ERC20.t.sol",
+    "test": "testBalanceOf",
+    "name": "token constructor",
+    "gasUsed": 7686226
+  },
+  {
+    "file": "test/ERC20.t.sol",
+    "test": "testTokenBurn",
+    "name": "token constructor",
+    "gasUsed": 7686226
+  },
+  {
+    "file": "test/ERC20.t.sol",
+    "test": "testTokenBurn",
+    "name": "token burn",
+    "gasUsed": 63648
+  },
+  {
+    "file": "test/ERC20.t.sol",
+    "test": "testTokenBurnInvalidCaller",
+    "name": "token constructor",
+    "gasUsed": 7686226
+  },
+  {
+    "file": "test/ERC20.t.sol",
+    "test": "testTokenBurnInvalidCaller",
+    "name": "token burn invalid caller",
+    "gasUsed": 32388
+  },
+  {
+    "file": "test/ERC20.t.sol",
+    "test": "testTokenBurnZeroAddress",
+    "name": "token constructor",
+    "gasUsed": 7686226
+  },
+  {
+    "file": "test/ERC20.t.sol",
+    "test": "testTokenBurnZeroAddress",
+    "name": "token burn zero address",
+    "gasUsed": 32309
+  },
+  {
+    "file": "test/ERC20.t.sol",
+    "test": "testTokenMint",
+    "name": "token constructor",
+    "gasUsed": 7686226
+  },
+  {
+    "file": "test/ERC20.t.sol",
+    "test": "testTokenMint",
+    "name": "token mint",
+    "gasUsed": 85313
+  },
+  {
+    "file": "test/ERC20.t.sol",
+    "test": "testTokenMintInvalidCaller",
+    "name": "token constructor",
+    "gasUsed": 7686226
+  },
+  {
+    "file": "test/ERC20.t.sol",
+    "test": "testTokenMintInvalidCaller",
+    "name": "token mint invalid caller",
+    "gasUsed": 32410
+  },
+  {
+    "file": "test/ERC20.t.sol",
+    "test": "testTokenMintToZeroAddress",
+    "name": "token constructor",
+    "gasUsed": 7686226
+  },
+  {
+    "file": "test/ERC20.t.sol",
+    "test": "testTokenMintToZeroAddress",
+    "name": "token mint to zero address",
+    "gasUsed": 32331
+  },
+  {
+    "file": "test/ERC20.t.sol",
+    "test": "testTokenSetUp",
+    "name": "token constructor",
+    "gasUsed": 7686226
+  },
+  {
+    "file": "test/ERC20.t.sol",
+    "test": "testTokenTransfer",
+    "name": "token constructor",
+    "gasUsed": 7686226
+  },
+  {
+    "file": "test/ERC20.t.sol",
+    "test": "testTokenTransfer",
+    "name": "token transfer",
+    "gasUsed": 74442
+  },
+  {
+    "file": "test/ERC20.t.sol",
+    "test": "testTokenTransferInsufficientBalance",
+    "name": "token constructor",
+    "gasUsed": 7686226
+  },
+  {
+    "file": "test/ERC20.t.sol",
+    "test": "testTokenTransferInsufficientBalance",
+    "name": "token transfer insufficient balance",
+    "gasUsed": 30032
+  },
+  {
+    "file": "test/ERC20.t.sol",
+    "test": "testTransferFrom",
+    "name": "token constructor",
+    "gasUsed": 7686226
+  },
+  {
+    "file": "test/ERC20.t.sol",
+    "test": "testTransferFrom",
+    "name": "token transferFrom",
+    "gasUsed": 86297
+  },
+  {
+    "file": "test/ERC20.t.sol",
+    "test": "testTransferFromInsufficientAllowance",
+    "name": "token constructor",
+    "gasUsed": 7686226
+  },
+  {
+    "file": "test/ERC20.t.sol",
+    "test": "testTransferFromInsufficientAllowance",
+    "name": "token transferFrom insufficient allowance",
+    "gasUsed": 32482
+  }
+]

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

@@ -0,0 +1,32 @@
+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: [], // Singleton table
+    },
+    Balances: {
+      schema: {
+        account: "address",
+        balance: "uint256",
+      },
+      key: ["account"],
+    },
+    Allowances: {
+      schema: {
+        account: "address",
+        spender: "address",
+        approval: "uint256",
+      },
+      key: ["account", "spender"],
+    },
+  },
+});

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

@@ -0,0 +1,63 @@
+{
+  "name": "@latticexyz/world-module-erc20-own-store",
+  "version": "2.1.1",
+  "description": "ERC20 World Module with Own 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": "pnpm run build:mud && pnpm run build:abi && pnpm run build:abi-ts && pnpm run build:js",
+    "build:abi": "forge build",
+    "build:abi-ts": "abi-ts",
+    "build:js": "tsup",
+    "build:mud": "tsx ./ts/build.ts",
+    "clean": "pnpm run clean:abi && pnpm run clean:js && pnpm run clean:mud",
+    "clean:abi": "forge clean",
+    "clean:js": "rimraf dist",
+    "clean:mud": "rimraf 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",
+    "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"
+  }
+}

packages/world-module-erc20-own-store/remappings.txt

@@ -0,0 +1,3 @@
+ds-test/=node_modules/ds-test/src/
+forge-std/=node_modules/forge-std/src/
+@latticexyz/=node_modules/@latticexyz/