Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DRAFT] refactor/SMA: Inheritable Account Refactor #133

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion .env.example
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

# Factory owner capable only of managing stake
OWNER=
# EP 0.7 address
Expand All @@ -22,3 +21,6 @@ UNSTAKE_DELAY=
# Allowlist Module
ALLOWLIST_MODULE=
ALLOWLIST_MODULE_SALT=

# Whether to test the semi-modular or full modular account
SMA_TEST=false
10 changes: 8 additions & 2 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,10 @@ jobs:
run: FOUNDRY_PROFILE=optimized-build forge build

- name: Run tests
run: FOUNDRY_PROFILE=optimized-test-deep forge test -vvv
run: FOUNDRY_PROFILE=optimized-test-deep SMA_TEST=false forge test -vvv

- name: Run SMA tests
run: FOUNDRY_PROFILE=optimized-test-deep SMA_TEST=true forge test -vvv

test-default:
name: Run Forge Tests (default)
Expand All @@ -88,4 +91,7 @@ jobs:
run: forge build

- name: Run tests
run: forge test -vvv
run: SMA_TEST=false forge test -vvv

- name: Run SMA tests
run: SMA_TEST=true forge test -vvv
2 changes: 1 addition & 1 deletion src/account/AccountFactory.sol
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ contract AccountFactory is Ownable {
return keccak256(abi.encodePacked(owner, salt, entityId));
}

function _getAddressFallbackSigner(bytes memory immutables, bytes32 salt) public view returns (address) {
function _getAddressFallbackSigner(bytes memory immutables, bytes32 salt) internal view returns (address) {
return LibClone.predictDeterministicAddressERC1967(address(ACCOUNT_IMPL), immutables, salt, address(this));
}

Expand Down
5 changes: 0 additions & 5 deletions src/account/AccountStorage.sol
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,6 @@ struct AccountStorage {
// AccountStorageInitializable variables
uint8 initialized;
bool initializing;
// Address for fallback single signer validation
address fallbackSigner;
// Whether or not the fallback signer is enabled, we can't use a zero fallbackSigner for this since it defaults
// to reading the bytecode-appended signer.
bool fallbackSignerDisabled;
// Execution functions and their associated functions
mapping(bytes4 selector => ExecutionData) executionData;
mapping(ModuleEntity validationFunction => ValidationData) validationData;
Expand Down
162 changes: 162 additions & 0 deletions src/account/SemiModularAccount.sol
Original file line number Diff line number Diff line change
@@ -0,0 +1,162 @@
// SPDX-License-Identifier: GPL-3.0
pragma solidity ^0.8.25;

import {UpgradeableModularAccount} from "./UpgradeableModularAccount.sol";
import {IEntryPoint} from "@eth-infinitism/account-abstraction/interfaces/IEntryPoint.sol";
import {PackedUserOperation} from "@eth-infinitism/account-abstraction/interfaces/PackedUserOperation.sol";

import {ModuleEntityLib} from "../helpers/ModuleEntityLib.sol";

import {ModuleEntity, ValidationConfig} from "../interfaces/IModuleManager.sol";

import {MessageHashUtils} from "@openzeppelin/contracts/utils/cryptography/MessageHashUtils.sol";
import {SignatureChecker} from "@openzeppelin/contracts/utils/cryptography/SignatureChecker.sol";
import {LibClone} from "solady/utils/LibClone.sol";

contract SemiModularAccount is UpgradeableModularAccount {
using MessageHashUtils for bytes32;
using ModuleEntityLib for ModuleEntity;

struct SemiModularAccountStorage {
address fallbackSigner;
bool fallbackSignerDisabled;
}

// keccak256("ERC6900.SemiModularAccount.Storage")
uint256 internal constant _SEMI_MODULAR_ACCOUNT_STORAGE_SLOT =
0x5b9dc9aa943f8fa2653ceceda5e3798f0686455280432166ba472eca0bc17a32;

ModuleEntity internal constant _FALLBACK_VALIDATION = ModuleEntity.wrap(bytes24(type(uint192).max));

event FallbackSignerSet(address indexed previousFallbackSigner, address indexed newFallbackSigner);
event FallbackSignerEnabledSet(bool prevEnabled, bool newEnabled);

error FallbackSignerMismatch();
error FallbackSignerDisabled();
error InitializerDisabled();

constructor(IEntryPoint anEntryPoint) UpgradeableModularAccount(anEntryPoint) {}

/// Override reverts on initialization, effectively disabling the initializer.
function initializeWithValidation(ValidationConfig, bytes4[] calldata, bytes calldata, bytes[] calldata)
external
override
initializer
{
revert InitializerDisabled();
}

/// @notice Updates the fallback signer address in storage.
/// @dev This function causes the fallback signer getter to ignore the bytecode signer if it is nonzero. It can
/// also be used to revert back to the bytecode signer by setting to zero.
/// @param fallbackSigner The new signer to set.
function updateFallbackSigner(address fallbackSigner) external wrapNativeFunction {
SemiModularAccountStorage storage _storage = _getSemiModularAccountStorage();
emit FallbackSignerSet(_storage.fallbackSigner, fallbackSigner);

_storage.fallbackSigner = fallbackSigner;
}

/// @notice Sets whether the fallback signer validation should be enabled or disabled.
function setFallbackSignerEnabled(bool enabled) external wrapNativeFunction {
SemiModularAccountStorage storage _storage = _getSemiModularAccountStorage();
emit FallbackSignerEnabledSet(!_storage.fallbackSignerDisabled, enabled);

_storage.fallbackSignerDisabled = !enabled;
}

function isFallbackSignerEnabled() external view returns (bool) {
return !_getSemiModularAccountStorage().fallbackSignerDisabled;
}

function getFallbackSigner() external view returns (address) {
return _getFallbackSigner();
}

function _execUserOpValidation(
ModuleEntity userOpValidationFunction,
PackedUserOperation memory userOp,
bytes32 userOpHash
) internal override returns (uint256) {
if (userOpValidationFunction.eq(_FALLBACK_VALIDATION)) {
address fallbackSigner = _getFallbackSigner();

if (
SignatureChecker.isValidSignatureNow(
fallbackSigner, userOpHash.toEthSignedMessageHash(), userOp.signature
)
) {
return _SIG_VALIDATION_PASSED;
}
return _SIG_VALIDATION_FAILED;
}

return super._execUserOpValidation(userOpValidationFunction, userOp, userOpHash);
}

function _execRuntimeValidation(
ModuleEntity runtimeValidationFunction,
bytes calldata callData,
bytes calldata authorization
) internal override {
if (runtimeValidationFunction.eq(_FALLBACK_VALIDATION)) {
address fallbackSigner = _getFallbackSigner();

if (msg.sender != fallbackSigner) {
revert FallbackSignerMismatch();
}
return;
}
super._execRuntimeValidation(runtimeValidationFunction, callData, authorization);
}

function _exec1271Validation(ModuleEntity sigValidation, bytes32 hash, bytes calldata signature)
internal
view
override
returns (bytes4)
{
if (sigValidation.eq(_FALLBACK_VALIDATION)) {
address fallbackSigner = _getFallbackSigner();

if (SignatureChecker.isValidSignatureNow(fallbackSigner, hash, signature)) {
return _1271_MAGIC_VALUE;
}
return _1271_INVALID;
}
return super._exec1271Validation(sigValidation, hash, signature);
}

function _globalValidationAllowed(bytes4 selector) internal view override returns (bool) {
return selector == this.updateFallbackSigner.selector || super._globalValidationAllowed(selector);
}

function _isValidationGlobal(ModuleEntity validationFunction) internal view override returns (bool) {
return validationFunction.eq(_FALLBACK_VALIDATION) || super._isValidationGlobal(validationFunction);
}

function _getFallbackSigner() internal view returns (address) {
SemiModularAccountStorage storage _storage = _getSemiModularAccountStorage();

if (_storage.fallbackSignerDisabled) {
revert FallbackSignerDisabled();
}

address storageFallbackSigner = _storage.fallbackSigner;
if (storageFallbackSigner != address(0)) {
return storageFallbackSigner;
}

bytes memory appendedData = LibClone.argsOnERC1967(address(this), 0, 20);

return address(uint160(bytes20(appendedData)));
}

function _getSemiModularAccountStorage() internal pure returns (SemiModularAccountStorage storage) {
SemiModularAccountStorage storage _storage;
assembly ("memory-safe") {
_storage.slot := _SEMI_MODULAR_ACCOUNT_STORAGE_SLOT
}
return _storage;
}
}
Loading
Loading