[DRAFT] SMA 1: Append initial validation data to bytecode

.env.example

@@ -0,0 +1,20 @@
+
+# Factory owner capable only of managing stake
+OWNER=
+# EP 0.7 address
+ENTRYPOINT=
+
+# Create2 expected addresses of the contracts.
+# When running for the first time, the error message will contain the expected addresses.
+ACCOUNT_IMPL=
+FACTORY=
+SINGLE_SIGNER_VALIDATION=
+
+# Optional, defaults to bytes32(0)
+ACCOUNT_IMPL_SALT=
+FACTORY_SALT=
+SINGLE_SIGNER_VALIDATION_SALT=
+
+# Optional, defaults to 0.1 ether and 1 day, respectively
+STAKE_AMOUNT=
+UNSTAKE_DELAY=

.gitignore

@@ -7,3 +7,14 @@ node_modules/
 # Coverage
 report/
 lcov.info
+
+# env vars
+.env
+
+# deployments
+broadcast/**/run-latest.json
+broadcast/**/dry-run/**/*
+
+# misc
+.DS_Store
+**/.DS_Store

.gitmodules

@@ -1,9 +1,15 @@
 [submodule "lib/account-abstraction"]
-	path = lib/account-abstraction
-	url = https://github.com/eth-infinitism/account-abstraction
+path = lib/account-abstraction
+url = https://github.com/eth-infinitism/account-abstraction
 [submodule "lib/openzeppelin-contracts"]
-	path = lib/openzeppelin-contracts
-	url = https://github.com/OpenZeppelin/openzeppelin-contracts
+path = lib/openzeppelin-contracts
+url = https://github.com/OpenZeppelin/openzeppelin-contracts
 [submodule "lib/forge-std"]
-	path = lib/forge-std
-	url = https://github.com/foundry-rs/forge-std
+path = lib/forge-std
+url = https://github.com/foundry-rs/forge-std
+[submodule "lib/modular-account-libs"]
+path = lib/modular-account-libs
+url = https://github.com/erc6900/modular-account-libs
+[submodule "lib/solady"]
+path = lib/solady
+url = https://github.com/vectorized/solady

.solhint-test.json

@@ -1,20 +1,20 @@
 {
-    "extends": "solhint:recommended",
-    "rules": {
-      "func-name-mixedcase": "off",
-      "immutable-vars-naming": ["error"],
-      "no-unused-import": ["error"],
-      "compiler-version": ["error", ">=0.8.19"],
-      "custom-errors": "off",
-      "func-visibility": ["error", { "ignoreConstructors": true }],
-      "max-line-length": ["error", 120],
-      "max-states-count": ["warn", 30],
-      "modifier-name-mixedcase": ["error"],
-      "private-vars-leading-underscore": ["error"],
-      "no-inline-assembly": "off",
-      "avoid-low-level-calls": "off",
-      "one-contract-per-file": "off",
-      "no-empty-blocks": "off"
-    }
+  "extends": "solhint:recommended",
+  "rules": {
+    "func-name-mixedcase": "off",
+    "immutable-vars-naming": ["error"],
+    "no-unused-import": ["error"],
+    "compiler-version": ["error", ">=0.8.19"],
+    "custom-errors": "off",
+    "func-visibility": ["error", { "ignoreConstructors": true }],
+    "max-line-length": ["error", 120],
+    "max-states-count": ["warn", 30],
+    "modifier-name-mixedcase": ["error"],
+    "private-vars-leading-underscore": ["error"],
+    "no-inline-assembly": "off",
+    "avoid-low-level-calls": "off",
+    "one-contract-per-file": "off",
+    "no-empty-blocks": "off",
+    "reason-string": ["warn", { "maxLength": 64 }]
   }
-  
+}

README.md

@@ -2,7 +2,7 @@
 
 Reference implementation for [ERC-6900](https://eips.ethereum.org/EIPS/eip-6900). It is an early draft implementation.
 
-The implementation includes an upgradable modular account with two plugins (`SingleOwnerPlugin` and `TokenReceiverPlugin`). It is compliant with ERC-6900 with the latest updates.
+The implementation includes an upgradable modular account with three modules (`SingleSignerValidation`, `TokenReceiverModule`, and `AllowlistModule`). It is compliant with ERC-6900 with the latest updates.
 
 ## Important Callouts
 
@@ -11,7 +11,7 @@ The implementation includes an upgradable modular account with two plugins (`Sin
 
 ## Development
 
-Anyone is welcome to submit feedback and/or PRs to improve code or add Plugins.
+Anyone is welcome to submit feedback and/or PRs to improve code.
 
 ### Testing
 
@@ -28,3 +28,14 @@ Since IR compilation generates different bytecode, it's useful to test against t
 FOUNDRY_PROFILE=optimized-build forge build
 FOUNDRY_PROFILE=optimized-test forge test -vvv
 ```
+
+## Integration testing
+
+The reference implementation provides a sample factory and deploy script for the factory, account implementation, and the demo validation module `SingleSignerValidation`. This is not auditted, nor intended for production use. Limitations set by the GPL-V3 license apply.
+
+To run this script, provide appropriate values in a `.env` file based on the `.env.example` template, then run:
+```bash
+forge script script/Deploy.s.sol <wallet options> -r <rpc_url> --broadcast
+```
+
+Where `<wallet_options>` specifies a way to sign the deployment transaction (see [here](https://book.getfoundry.sh/reference/forge/forge-script#wallet-options---raw)) and `<rpc_url>` specifies an RPC for the network you are deploying on.

deployments/arb-sepolia.md

@@ -0,0 +1,21 @@
+# Arbitrum Sepolia
+
+Chain ID: 421614
+
+## AccountFactory
+
+| Version        | Address                                      | Explorer                                                                                   | Salt |
+| -------------- | -------------------------------------------- | ------------------------------------------------------------------------------------------ | ---- |
+| v0.8.0-alpha.0 | `0x1c7EF41AA9896b74223a3956c7dDE28F206E8b24` | [explorer](https://sepolia.arbiscan.io/address/0x1c7EF41AA9896b74223a3956c7dDE28F206E8b24) | `0`  |
+
+## UpgradeableModularAccount Implementation
+
+| Version        | Address                                      | Explorer                                                                                   | Salt |
+| -------------- | -------------------------------------------- | ------------------------------------------------------------------------------------------ | ---- |
+| v0.8.0-alpha.0 | `0x0809BF385117a43A322A4E31d459c0EcaA3B1A08` | [explorer](https://sepolia.arbiscan.io/address/0x0809BF385117a43A322A4E31d459c0EcaA3B1A08) | `0`  |
+
+## SingleSignerValidation
+
+| Version        | Address                                      | Explorer                                                                                   | Salt |
+| -------------- | -------------------------------------------- | ------------------------------------------------------------------------------------------ | ---- |
+| v0.8.0-alpha.0 | `0x9DA8c098A483E257dd96022831DF308cB24fCBE6` | [explorer](https://sepolia.arbiscan.io/address/0x9DA8c098A483E257dd96022831DF308cB24fCBE6) | `0`  |

foundry.toml

@@ -7,21 +7,23 @@ libs = ['lib']
 out = 'out'
 optimizer = true
 optimizer_runs = 200
-fs_permissions = [
-  { access = "read", path = "./out-optimized" }
-]
+auto_detect_solc = false
+bytecode_hash = "none"
+auto_detect_remappings = false
+fs_permissions = [{ access = "read", path = "./out-optimized" }]
 
 [fuzz]
 runs = 500
 
 [invariant]
-runs=500
+runs = 500
 fail_on_revert = true
 depth = 10
 
 [profile.optimized-build]
 via_ir = true
 test = 'src'
+optimizer_runs = 20000
 out = 'out-optimized'
 
 [profile.optimized-test]
@@ -38,7 +40,7 @@ runs = 5000
 depth = 32
 
 [profile.deep.fuzz]
-runs = 10000
+runs = 100000
 
 [profile.deep.invariant]
 runs = 5000
@@ -47,13 +49,8 @@ depth = 32
 [fmt]
 line_length = 115
 wrap_comments = true
-
-[rpc_endpoints]
-mainnet = "${RPC_URL_MAINNET}"
-goerli = "${RPC_URL_GOERLI}"
-
-[etherscan]
-mainnet = { key = "${ETHERSCAN_API_KEY}" }
-goerli = { key = "${ETHERSCAN_API_KEY}" }
+sort_imports = true
+number_underscore = "thousands"
+int_types = "long"
 
 # See more config options https://github.com/foundry-rs/foundry/tree/master/config

package.json

@@ -5,7 +5,7 @@
   },
   "scripts": {
     "lint": "pnpm lint:src && pnpm lint:test",
-    "lint:src": "solhint -c .solhint-src.json './src/**/*.sol'",
-    "lint:test": "solhint -c .solhint-test.json './test/**/*.sol'"
+    "lint:src": "solhint --max-warnings 0 -c .solhint-src.json './src/**/*.sol'",
+    "lint:test": "solhint --max-warnings 0 -c .solhint-test.json './test/**/*.sol'"
   }
 }

remappings.txt

@@ -2,3 +2,5 @@ ds-test/=lib/forge-std/lib/ds-test/src/
 forge-std/=lib/forge-std/src/
 @eth-infinitism/account-abstraction/=lib/account-abstraction/contracts/
 @openzeppelin/=lib/openzeppelin-contracts/
+@modular-account-libs/=lib/modular-account-libs/src/
+solady=lib/solady/src/

script/Deploy.s.sol

@@ -0,0 +1,162 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.8.25;
+
+import {IEntryPoint} from "@eth-infinitism/account-abstraction/interfaces/IEntryPoint.sol";
+import {Script} from "forge-std/Script.sol";
+import {console2} from "forge-std/Test.sol";
+
+import {Create2} from "@openzeppelin/contracts/utils/Create2.sol";
+
+import {AccountFactory} from "../src/account/AccountFactory.sol";
+import {UpgradeableModularAccount} from "../src/account/UpgradeableModularAccount.sol";
+import {SingleSignerValidation} from "../src/modules/validation/SingleSignerValidation.sol";
+
+contract DeployScript is Script {
+    IEntryPoint public entryPoint = IEntryPoint(payable(vm.envAddress("ENTRYPOINT")));
+
+    address public owner = vm.envAddress("OWNER");
+
+    address public accountImpl = vm.envOr("ACCOUNT_IMPL", address(0));
+    address public factory = vm.envOr("FACTORY", address(0));
+    address public singleSignerValidation = vm.envOr("SINGLE_SIGNER_VALIDATION", address(0));
+
+    bytes32 public accountImplSalt = bytes32(vm.envOr("ACCOUNT_IMPL_SALT", uint256(0)));
+    bytes32 public factorySalt = bytes32(vm.envOr("FACTORY_SALT", uint256(0)));
+    bytes32 public singleSignerValidationSalt = bytes32(vm.envOr("SINGLE_SIGNER_VALIDATION_SALT", uint256(0)));
+
+    uint256 public requiredStakeAmount = vm.envOr("STAKE_AMOUNT", uint256(0.1 ether));
+    uint256 public requiredUnstakeDelay = vm.envOr("UNSTAKE_DELAY", uint256(1 days));
+
+    function run() public {
+        console2.log("******** Deploying ERC-6900 Reference Implementation ********");
+        console2.log("Chain: ", block.chainid);
+        console2.log("EP: ", address(entryPoint));
+        console2.log("Factory owner: ", owner);
+
+        vm.startBroadcast();
+        _deployAccountImpl(accountImplSalt, accountImpl);
+        _deploySingleSignerValidation(singleSignerValidationSalt, singleSignerValidation);
+        _deployAccountFactory(factorySalt, factory);
+        _addStakeForFactory(uint32(requiredUnstakeDelay), requiredStakeAmount);
+        vm.stopBroadcast();
+    }
+
+    function _deployAccountImpl(bytes32 salt, address expected) internal {
+        console2.log(string.concat("Deploying AccountImpl with salt: ", vm.toString(salt)));
+
+        address addr = Create2.computeAddress(
+            salt,
+            keccak256(abi.encodePacked(type(UpgradeableModularAccount).creationCode, abi.encode(entryPoint))),
+            CREATE2_FACTORY
+        );
+        if (addr != expected) {
+            console2.log("Expected address mismatch");
+            console2.log("Expected: ", expected);
+            console2.log("Actual: ", addr);
+            revert();
+        }
+
+        if (addr.code.length == 0) {
+            console2.log("No code found at expected address, deploying...");
+            UpgradeableModularAccount deployed = new UpgradeableModularAccount{salt: salt}(entryPoint);
+
+            if (address(deployed) != expected) {
+                console2.log("Deployed address mismatch");
+                console2.log("Expected: ", expected);
+                console2.log("Deployed: ", address(deployed));
+                revert();
+            }
+
+            console2.log("Deployed AccountImpl at: ", address(deployed));
+        } else {
+            console2.log("Code found at expected address, skipping deployment");
+        }
+    }
+
+    function _deploySingleSignerValidation(bytes32 salt, address expected) internal {
+        console2.log(string.concat("Deploying SingleSignerValidation with salt: ", vm.toString(salt)));
+
+        address addr = Create2.computeAddress(
+            salt, keccak256(abi.encodePacked(type(SingleSignerValidation).creationCode)), CREATE2_FACTORY
+        );
+        if (addr != expected) {
+            console2.log("Expected address mismatch");
+            console2.log("Expected: ", expected);
+            console2.log("Actual: ", addr);
+            revert();
+        }
+
+        if (addr.code.length == 0) {
+            console2.log("No code found at expected address, deploying...");
+            SingleSignerValidation deployed = new SingleSignerValidation{salt: salt}();
+
+            if (address(deployed) != expected) {
+                console2.log("Deployed address mismatch");
+                console2.log("Expected: ", expected);
+                console2.log("Deployed: ", address(deployed));
+                revert();
+            }
+
+            console2.log("Deployed SingleSignerValidation at: ", address(deployed));
+        } else {
+            console2.log("Code found at expected address, skipping deployment");
+        }
+    }
+
+    function _deployAccountFactory(bytes32 salt, address expected) internal {
+        console2.log(string.concat("Deploying AccountFactory with salt: ", vm.toString(salt)));
+
+        address addr = Create2.computeAddress(
+            salt,
+            keccak256(
+                abi.encodePacked(
+                    type(AccountFactory).creationCode,
+                    abi.encode(entryPoint, accountImpl, singleSignerValidation, owner)
+                )
+            ),
+            CREATE2_FACTORY
+        );
+        if (addr != expected) {
+            console2.log("Expected address mismatch");
+            console2.log("Expected: ", expected);
+            console2.log("Actual: ", addr);
+            revert();
+        }
+
+        if (addr.code.length == 0) {
+            console2.log("No code found at expected address, deploying...");
+            AccountFactory deployed = new AccountFactory{salt: salt}(
+                entryPoint, UpgradeableModularAccount(payable(accountImpl)), singleSignerValidation, owner
+            );
+
+            if (address(deployed) != expected) {
+                console2.log("Deployed address mismatch");
+                console2.log("Expected: ", expected);
+                console2.log("Deployed: ", address(deployed));
+                revert();
+            }
+
+            console2.log("Deployed AccountFactory at: ", address(deployed));
+        } else {
+            console2.log("Code found at expected address, skipping deployment");
+        }
+    }
+
+    function _addStakeForFactory(uint32 unstakeDelay, uint256 stakeAmount) internal {
+        console2.log("Adding stake to factory");
+
+        uint256 currentStake = entryPoint.getDepositInfo(address(factory)).stake;
+        console2.log("Current stake: ", currentStake);
+        uint256 stakeToAdd = stakeAmount - currentStake;
+
+        if (stakeToAdd > 0) {
+            console2.log("Adding stake: ", stakeToAdd);
+            entryPoint.addStake{value: stakeToAdd}(unstakeDelay);
+            console2.log("Staked factory: ", address(factory));
+            console2.log("Total stake amount: ", entryPoint.getDepositInfo(address(factory)).stake);
+            console2.log("Unstake delay: ", entryPoint.getDepositInfo(address(factory)).unstakeDelaySec);
+        } else {
+            console2.log("No stake to add");
+        }
+    }
+}