Skip to content

Commit 30f62f7

Browse files
authored
docs: update README for 0.8.0 (#210)
1 parent bfe5d75 commit 30f62f7

File tree

6 files changed

+43
-8032
lines changed

6 files changed

+43
-8032
lines changed

README.md

Lines changed: 42 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,53 @@
11
# ERC-6900 Reference Implementation
22

3-
Reference implementation for [ERC-6900](https://eips.ethereum.org/EIPS/eip-6900).
3+
[![tg_badge]][tg_link]
44

5-
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.
5+
[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
6+
[tg_link]: https://t.me/modular_account_standards
67

7-
## Important callouts
8+
Reference implementation for [ERC-6900](https://eips.ethereum.org/EIPS/eip-6900).
89

9-
- **Not audited and SHOULD NOT be used in production**.
10-
- Not optimized in both deployments and execution. We’ve explicitly removed some optimizations in favor of clarity.
10+
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.
11+
12+
> [!IMPORTANT]
13+
> Unless otherwise stated, these contracts are not audited and SHOULD NOT be used in production.
14+
15+
- Reference account implementations
16+
- [ReferenceModularAccount](src/account/ReferenceModularAccount.sol): A simple ERC-6900 compatible account.
17+
- [SemiModularAccount](src/account/SemiModularAccount.sol): An ERC-6900 account that includes a fallback validation mechanism.
18+
- Factory
19+
- [AccountFactory](src/account/AccountFactory.sol): Deploys both account types.
20+
- ERC-6900 interfaces: [src/interfaces](src/interfaces/)
21+
- Helpers
22+
- [CollectReturnData](src/helpers/CollectReturnData.sol)
23+
- [Constants](src/helpers/Constants.sol): ✅ Audited ([reports](https://github.com/alchemyplatform/modular-account/tree/develop/audits))
24+
- [EmptyCalldataSlice](src/helpers/EmptyCalldataSlice.sol): ✅ Audited ([reports](https://github.com/alchemyplatform/modular-account/tree/develop/audits))
25+
- [ValidationResHelpers](src/helpers/ValidationResHelpers.sol)
26+
- Libraries
27+
- [HookConfigLib](src/libraries/HookConfigLib.sol): ✅ Audited ([reports](https://github.com/alchemyplatform/modular-account/tree/develop/audits))
28+
- [KnownSelectorsLib](src/libraries/KnownSelectorsLib.sol)
29+
- [ModuleEntityLib](src/libraries/ModuleEntityLib.sol): ✅ Audited ([reports](https://github.com/alchemyplatform/modular-account/tree/develop/audits))
30+
- [ModuleStorageLib](src/libraries/ModuleStorageLib.sol)
31+
- [SparseCalldataSegmentLib](src/libraries/SparseCalldataSegmentLib.sol): ✅ Audited ([reports](https://github.com/alchemyplatform/modular-account/tree/develop/audits))
32+
- [ValidationConfigLib](src/libraries/ValidationConfigLib.sol): ✅ Audited ([reports](https://github.com/alchemyplatform/modular-account/tree/develop/audits))
33+
- ERC-6900 compatible modules
34+
- Validation modules:
35+
- [SingleSignerValidationModule](src/modules/validation/SingleSignerValidationModule.sol): Enables validation for a single signer (EOA or contract).
36+
- Permission-enforcing hook modules:
37+
- [AllowlistModule](src/modules/permissions/AllowlistModule.sol): Enforces address/selector allowlists.
38+
- [ERC20TokenLimitModule](src/modules/permissions/ERC20TokenLimitModule.sol): Enforces ERC-20 spend limits.
39+
- [NativeTokenLimitModule](src/modules/permissions/NativeTokenLimitModule.sol): Enforces native token spend limits.
40+
- Execution modules:
41+
- [TokenReceiverModule](src/modules/TokenReceiverModule.sol): Allows the account to receive ERC-721 and ERC-1155 tokens.
42+
- Module utilities
43+
- [ModuleEIP712](src/modules/ModuleEIP712.sol): ✅ Audited ([reports](https://github.com/alchemyplatform/modular-account/tree/develop/audits))
44+
- [ReplaySafeWrapper](src/modules/ReplaySafeWrapper.sol): ✅ Audited ([reports](https://github.com/alchemyplatform/modular-account/tree/develop/audits))
1145

1246
## Development
1347

14-
Anyone is welcome to submit feedback and/or PRs to improve code.
48+
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).
1549

16-
### Testing
50+
## Testing
1751

1852
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.
1953

@@ -29,7 +63,7 @@ FOUNDRY_PROFILE=optimized-build forge build
2963
FOUNDRY_PROFILE=optimized-test forge test -vvv
3064
```
3165

32-
## Integration testing
66+
### Integration testing
3367

3468
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.
3569

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@erc6900/reference-implementation",
3-
"version": "0.8.0-rc.7",
3+
"version": "0.8.0",
44
"devDependencies": {
55
"pnpm": "^8.7.5",
66
"solhint": "^3.6.2"

0 commit comments

Comments
 (0)