Merge branch 'develop' into feat/npm

Author: huaweigu

LICENSE

@@ -1,19 +1,53 @@
 # ERC-6900 Reference Implementation
 
-Reference implementation for [ERC-6900](https://eips.ethereum.org/EIPS/eip-6900).
+[![tg_badge]][tg_link]
 
-The implementation includes an upgradable modular account with 5 modules (`SingleSignerValidationModule`, `TokenReceiverModule`, `AllowlistModule`, `ERC20TokenLimitModule`, and `NativeTokenLimitModule`). It is compliant with the latest version of ERC-6900.
+[tg_badge]: https://img.shields.io/endpoint?color=neon&logo=telegram&label=chat&url=https://mogyo.ro/quart-apis/tgmembercount?chat_id=modular_account_standards
+[tg_link]: https://t.me/modular_account_standards
 
-## Important callouts
+Reference implementation for [ERC-6900](https://eips.ethereum.org/EIPS/eip-6900).
 
-- **Not audited and SHOULD NOT be used in production**.
-- Not optimized in both deployments and execution. We’ve explicitly removed some optimizations in favor of clarity.
+This repository contains the contracts below which are compliant with the latest version of ERC-6900. They are not optimized in both deployments and execution. We’ve explicitly removed some optimizations in favor of clarity.
+
+> [!IMPORTANT]  
+> Unless otherwise stated, these contracts are not audited and SHOULD NOT be used in production.
+
+- Reference account implementations
+  - [ReferenceModularAccount](src/account/ReferenceModularAccount.sol): A simple ERC-6900 compatible account.
+  - [SemiModularAccount](src/account/SemiModularAccount.sol): An ERC-6900 account that includes a fallback validation mechanism.
+- Factory
+  - [AccountFactory](src/account/AccountFactory.sol): Deploys both account types.
+- ERC-6900 interfaces: [src/interfaces](src/interfaces/)
+- Helpers
+  - [CollectReturnData](src/helpers/CollectReturnData.sol)
+  - [Constants](src/helpers/Constants.sol): ✅ Audited ([reports](https://github.com/alchemyplatform/modular-account/tree/develop/audits))
+  - [EmptyCalldataSlice](src/helpers/EmptyCalldataSlice.sol): ✅ Audited ([reports](https://github.com/alchemyplatform/modular-account/tree/develop/audits))
+  - [ValidationResHelpers](src/helpers/ValidationResHelpers.sol)
+- Libraries
+  - [HookConfigLib](src/libraries/HookConfigLib.sol): ✅ Audited ([reports](https://github.com/alchemyplatform/modular-account/tree/develop/audits))
+  - [KnownSelectorsLib](src/libraries/KnownSelectorsLib.sol)
+  - [ModuleEntityLib](src/libraries/ModuleEntityLib.sol): ✅ Audited ([reports](https://github.com/alchemyplatform/modular-account/tree/develop/audits))
+  - [ModuleStorageLib](src/libraries/ModuleStorageLib.sol)
+  - [SparseCalldataSegmentLib](src/libraries/SparseCalldataSegmentLib.sol): ✅ Audited ([reports](https://github.com/alchemyplatform/modular-account/tree/develop/audits))
+  - [ValidationConfigLib](src/libraries/ValidationConfigLib.sol): ✅ Audited ([reports](https://github.com/alchemyplatform/modular-account/tree/develop/audits))
+- ERC-6900 compatible modules
+  - Validation modules:
+    - [SingleSignerValidationModule](src/modules/validation/SingleSignerValidationModule.sol): Enables validation for a single signer (EOA or contract).
+  - Permission-enforcing hook modules:
+    - [AllowlistModule](src/modules/permissions/AllowlistModule.sol): Enforces address/selector allowlists.
+    - [ERC20TokenLimitModule](src/modules/permissions/ERC20TokenLimitModule.sol): Enforces ERC-20 spend limits.
+    - [NativeTokenLimitModule](src/modules/permissions/NativeTokenLimitModule.sol): Enforces native token spend limits.
+  - Execution modules:
+    - [TokenReceiverModule](src/modules/TokenReceiverModule.sol): Allows the account to receive ERC-721 and ERC-1155 tokens.
+- Module utilities
+  - [ModuleEIP712](src/modules/ModuleEIP712.sol): ✅ Audited ([reports](https://github.com/alchemyplatform/modular-account/tree/develop/audits))
+  - [ReplaySafeWrapper](src/modules/ReplaySafeWrapper.sol): ✅ Audited ([reports](https://github.com/alchemyplatform/modular-account/tree/develop/audits))
 
 ## Development
 
-Anyone is welcome to submit feedback and/or PRs to improve code.
+Anyone is welcome to submit feedback and/or PRs to improve the code. For standard improvement proposals and discussions, join us at https://github.com/erc6900/resources/issues or [Ethereum Magicians](https://ethereum-magicians.org/t/erc-6900-modular-smart-contract-accounts-and-plugins/13885).
 
-### Testing
+## Testing
 
 The default Foundry profile can be used to compile (without IR) and test the entire project. The default profile should be used when generating coverage and debugging.
 
@@ -29,9 +63,9 @@ FOUNDRY_PROFILE=optimized-build forge build
 FOUNDRY_PROFILE=optimized-test forge test -vvv
 ```
 
-## Integration testing
+### Integration testing
 
-The reference implementation provides a sample factory and deploy script for the factory, account implementation, and the demo validation module `SingleSignerValidationModule`. This is not audited nor intended for production use. Limitations set by the GPLv3 license apply.
+The reference implementation provides a sample factory and deploy script for the factory, account implementation, and the demo validation module `SingleSignerValidationModule`. This is not audited nor intended for production use. Limitations set by the MIT license apply.
 
 To run this script, provide appropriate values in a `.env` file based on the `.env.example` template, then run:
 

README.md

@@ -0,0 +1,5 @@
+{
+  "opRetro": {
+    "projectId": "0x27cbcfd7678c199355b12b66d6449531a4015998d1793640456392e8564af155"
+  }
+}

funding.json

@@ -23,7 +23,7 @@
     "erc6900"
   ],
   "author": "ERC6900 Community",
-  "license": "GPL-3.0",
+  "license": "MIT",
   "bugs": {
     "url": "https://github.com/erc6900/reference-implementation/issues"
   },

package.json

@@ -1,4 +1,4 @@
-// SPDX-License-Identifier: GPL-3.0
+// SPDX-License-Identifier: MIT
 pragma solidity ^0.8.20;
 
 import {IEntryPoint} from "@eth-infinitism/account-abstraction/interfaces/IEntryPoint.sol";

script/Deploy.s.sol

@@ -1,4 +1,4 @@
-// SPDX-License-Identifier: GPL-3.0
+// SPDX-License-Identifier: MIT
 pragma solidity ^0.8.20;
 
 import {Script, console} from "forge-std/Script.sol";

script/DeployAllowlistModule.s.sol

@@ -1,4 +1,4 @@
-// SPDX-License-Identifier: GPL-3.0
+// SPDX-License-Identifier: MIT
 pragma solidity ^0.8.20;
 
 abstract contract AccountExecutor {

src/account/AccountExecutor.sol

@@ -1,4 +1,4 @@
-// SPDX-License-Identifier: GPL-3.0
+// SPDX-License-Identifier: MIT
 pragma solidity ^0.8.20;
 
 import {IEntryPoint} from "@eth-infinitism/account-abstraction/interfaces/IEntryPoint.sol";

src/account/AccountFactory.sol

@@ -1,9 +1,9 @@
-// SPDX-License-Identifier: GPL-3.0
+// SPDX-License-Identifier: MIT
 pragma solidity ^0.8.20;
 
 import {EnumerableSet} from "@openzeppelin/contracts/utils/structs/EnumerableSet.sol";
 
-import {HookConfig, ModuleEntity} from "../interfaces/IModularAccount.sol";
+import {HookConfig, ModuleEntity, ValidationFlags} from "../interfaces/IERC6900Account.sol";
 
 // bytes = keccak256("ERC6900.ReferenceModularAccount.Storage")
 bytes32 constant _ACCOUNT_STORAGE_SLOT = 0xc531f081ecdb5a90f38c197521797881a6e5c752a7d451780f325a95f8b91f45;
@@ -25,12 +25,12 @@ struct ExecutionStorage {
 }
 
 struct ValidationStorage {
-    // Whether or not this validation can be used as a global validation function.
-    bool isGlobal;
-    // Whether or not this validation is allowed to validate ERC-1271 signatures.
-    bool isSignatureValidation;
-    // Whether or not this validation is allowed to validate ERC-4337 user operations.
-    bool isUserOpValidation;
+    // ValidationFlags layout:
+    // 0b00000___ // unused
+    // 0b_____A__ // isGlobal
+    // 0b______B_ // isSignatureValidation
+    // 0b_______C // isUserOpValidation
+    ValidationFlags validationFlags;
     // The validation hooks for this validation function.
     HookConfig[] validationHooks;
     // Execution hooks to run with this validation function.

src/account/AccountStorage.sol

@@ -1,4 +1,4 @@
-// SPDX-License-Identifier: GPL-3.0
+// SPDX-License-Identifier: MIT
 pragma solidity ^0.8.20;
 
 import {AccountStorage, getAccountStorage} from "./AccountStorage.sol";