Skip to content

Commit

Permalink
feat: change deferred validation to deferred action
Browse files Browse the repository at this point in the history
  • Loading branch information
@adamegyed
adamegyed committed Oct 11, 2024
1 parent 357e567 commit 1aef4f5
Show file tree
Hide file tree
Showing 11 changed files with 355 additions and 106 deletions.
2 changes: 1 addition & 1 deletion .forge-snapshots/ModularAccount_UserOp_deferredValidation.snap
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
257016
257468
2 changes: 1 addition & 1 deletion .forge-snapshots/SemiModularAccount_UserOp_deferredValidation.snap
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
253636
254088
25 changes: 16 additions & 9 deletions gas/modular-account/ModularAccount.gas.t.sol
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,10 @@ pragma solidity ^0.8.26;
import {ModuleEntity} from "@erc6900/reference-implementation/interfaces/IModularAccount.sol";

import {Call} from "@erc6900/reference-implementation/interfaces/IModularAccount.sol";
import {ValidationConfigLib} from "@erc6900/reference-implementation/libraries/ValidationConfigLib.sol";
import {
ValidationConfig,
ValidationConfigLib
} from "@erc6900/reference-implementation/libraries/ValidationConfigLib.sol";
import {PackedUserOperation} from "@eth-infinitism/account-abstraction/interfaces/PackedUserOperation.sol";
import {MessageHashUtils} from "@openzeppelin/contracts/utils/cryptography/MessageHashUtils.sol";
import {Vm} from "forge-std/src/Vm.sol";
Expand Down Expand Up @@ -261,14 +264,12 @@ contract ModularAccountGasTest is ModularAccountBenchmarkBase("ModularAccount")
(uint8 v, bytes32 r, bytes32 s) = vm.sign(owner2Key, MessageHashUtils.toEthSignedMessageHash(userOpHash));
bytes memory uoValidationSig = _packFinalSignature(abi.encodePacked(EOA_TYPE_SIGNATURE, r, s, v));

ValidationConfig newUOValidation =
ValidationConfigLib.pack(address(newValidationModule), newEntityId, true, false, true);

bytes memory deferredValidationInstallCall = abi.encodeCall(
ModularAccountBase.installValidation,
(
ValidationConfigLib.pack(address(newValidationModule), newEntityId, true, false, true),
new bytes4[](0),
abi.encode(newEntityId, owner2),
new bytes[](0)
)
(newUOValidation, new bytes4[](0), abi.encode(newEntityId, owner2), new bytes[](0))
);

uint256 deferredInstallNonce = 0;
Expand All @@ -282,7 +283,11 @@ contract ModularAccountGasTest is ModularAccountBenchmarkBase("ModularAccount")
account1,
ecdsaValidationModule,
_getDeferredInstallHash(
account1, deferredInstallNonce, deferredInstallDeadline, deferredValidationInstallCall
account1,
deferredInstallNonce,
deferredInstallDeadline,
newUOValidation,
deferredValidationInstallCall
)
)
)
Expand All @@ -291,7 +296,9 @@ contract ModularAccountGasTest is ModularAccountBenchmarkBase("ModularAccount")
userOp.signature = _encodeDeferredInstallUOSignature(
signerValidation,
GLOBAL_VALIDATION,
_packDeferredInstallData(deferredInstallNonce, deferredInstallDeadline, deferredValidationInstallCall),
_packDeferredInstallData(
deferredInstallNonce, deferredInstallDeadline, newUOValidation, deferredValidationInstallCall
),
deferredValidationSig,
uoValidationSig
);
Expand Down
25 changes: 16 additions & 9 deletions gas/modular-account/SemiModularAccount.gas.t.sol
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,10 @@ pragma solidity ^0.8.26;
import {ModuleEntity} from "@erc6900/reference-implementation/interfaces/IModularAccount.sol";

import {Call} from "@erc6900/reference-implementation/interfaces/IModularAccount.sol";
import {ValidationConfigLib} from "@erc6900/reference-implementation/libraries/ValidationConfigLib.sol";
import {
ValidationConfig,
ValidationConfigLib
} from "@erc6900/reference-implementation/libraries/ValidationConfigLib.sol";
import {PackedUserOperation} from "@eth-infinitism/account-abstraction/interfaces/PackedUserOperation.sol";
import {MessageHashUtils} from "@openzeppelin/contracts/utils/cryptography/MessageHashUtils.sol";
import {Vm} from "forge-std/src/Vm.sol";
Expand Down Expand Up @@ -256,14 +259,12 @@ contract ModularAccountGasTest is ModularAccountBenchmarkBase("SemiModularAccoun
(uint8 v, bytes32 r, bytes32 s) = vm.sign(owner2Key, MessageHashUtils.toEthSignedMessageHash(userOpHash));
bytes memory uoValidationSig = _packFinalSignature(abi.encodePacked(EOA_TYPE_SIGNATURE, r, s, v));

ValidationConfig newUOValidation =
ValidationConfigLib.pack(address(newValidationModule), newEntityId, true, false, true);

bytes memory deferredValidationInstallCall = abi.encodeCall(
ModularAccountBase.installValidation,
(
ValidationConfigLib.pack(address(newValidationModule), newEntityId, true, false, true),
new bytes4[](0),
abi.encode(newEntityId, owner2),
new bytes[](0)
)
(newUOValidation, new bytes4[](0), abi.encode(newEntityId, owner2), new bytes[](0))
);

uint256 deferredInstallNonce = 0;
Expand All @@ -276,7 +277,11 @@ contract ModularAccountGasTest is ModularAccountBenchmarkBase("SemiModularAccoun
_getSMAReplaySafeHash(
account1,
_getDeferredInstallHash(
account1, deferredInstallNonce, deferredInstallDeadline, deferredValidationInstallCall
account1,
deferredInstallNonce,
deferredInstallDeadline,
newUOValidation,
deferredValidationInstallCall
)
)
)
Expand All @@ -285,7 +290,9 @@ contract ModularAccountGasTest is ModularAccountBenchmarkBase("SemiModularAccoun
userOp.signature = _encodeDeferredInstallUOSignature(
signerValidation,
GLOBAL_VALIDATION,
_packDeferredInstallData(deferredInstallNonce, deferredInstallDeadline, deferredValidationInstallCall),
_packDeferredInstallData(
deferredInstallNonce, deferredInstallDeadline, newUOValidation, deferredValidationInstallCall
),
deferredValidationSig,
uoValidationSig
);
Expand Down
2 changes: 1 addition & 1 deletion src/account/AccountStorage.sol
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ struct AccountStorage {
mapping(ModuleEntity validationFunction => ValidationData) validationData;
// For ERC165 introspection
mapping(bytes4 => uint256) supportedIfaces;
mapping(uint256 => bool) deferredInstallNonceUsed;
mapping(uint256 => bool) deferredActionNonceUsed;
}

function getAccountStorage() pure returns (AccountStorage storage _storage) {
Expand Down
118 changes: 62 additions & 56 deletions src/account/ModularAccountBase.sol
View file
Original file line number Diff line number Diff line change
Expand Up @@ -72,9 +72,9 @@ abstract contract ModularAccountBase is
bytes32 internal constant _DOMAIN_SEPARATOR_TYPEHASH =
0x47e79534a245952e8b16893a336b85a3d9ea9fa8c573f3d803afb92a79469218;

// keccak256("InstallValidation(uint256 nonce,uint48 deadline,bytes validationInstall)")
bytes32 internal constant _INSTALL_VALIDATION_TYPEHASH =
0x03ffe0a4f7bbcd0e07af14f95a1c08895063811809f7bedb7ac6a2cce22acd5f;
// keccak256("DeferredAction(uint256 nonce,uint48 deadline,bytes25 validationFunction,bytes call)")
bytes32 internal constant _DEFERRED_ACTION_TYPEHASH =
0xa17377cb6cfc0b2dd5d19181605c29f5d15050cfef9781c26049921c79e525d2;

// As per the EIP-165 spec, no interface should ever match 0xffffffff
bytes4 internal constant _INTERFACE_ID_INVALID = 0xffffffff;
Expand All @@ -84,9 +84,9 @@ abstract contract ModularAccountBase is
bytes4 internal constant _1271_INVALID = 0xffffffff;

uint8 internal constant _IS_GLOBAL_VALIDATION_BIT = 1;
uint8 internal constant _IS_DEFERRED_INSTALL_VALIDATION_BIT = 2;
uint8 internal constant _HAS_DEFERRED_ACTION_BIT = 2;

event DeferredInstallNonceInvalidated(uint256 nonce);
event DeferredActionNonceInvalidated(uint256 nonce);

error PostExecHookReverted(address module, uint32 entityId, bytes revertReason);
error PreExecHookReverted(address module, uint32 entityId, bytes revertReason);
Expand All @@ -99,9 +99,8 @@ abstract contract ModularAccountBase is
error UnexpectedAggregator(address module, uint32 entityId, address aggregator);
error UnrecognizedFunction(bytes4 selector);
error ValidationFunctionMissing(bytes4 selector);
error DeferredInstallSelectorInvalid();
error DeferredInstallNonceInvalid();
error DeferredInstallSignatureInvalid();
error DeferredActionNonceInvalid();
error DeferredActionSignatureInvalid();
error CreateFailed();

// Wraps execution of a native function with runtime validation and hooks
Expand Down Expand Up @@ -363,8 +362,8 @@ abstract contract ModularAccountBase is

/// @notice May be validated by a global validation
function invalidateDeferredValidationInstallNonce(uint256 nonce) external wrapNativeFunction {
getAccountStorage().deferredInstallNonceUsed[nonce] = true;
emit DeferredInstallNonceInvalidated(nonce);
getAccountStorage().deferredActionNonceUsed[nonce] = true;
emit DeferredActionNonceInvalidated(nonce);
}

/// @inheritdoc IERC165
Expand Down Expand Up @@ -423,7 +422,7 @@ abstract contract ModularAccountBase is
// Decode the 25th byte into an 8-bit bitmap (6 bits of which remain unused).
uint8 validationFlags = uint8(userOp.signature[24]);
bool isGlobalValidation = validationFlags & _IS_GLOBAL_VALIDATION_BIT != 0;
bool isDeferredInstallValidation = validationFlags & _IS_DEFERRED_INSTALL_VALIDATION_BIT != 0;
bool hasDeferredAction = validationFlags & _HAS_DEFERRED_ACTION_BIT != 0;

// Assigned depending on whether the UO uses deferred validation installation or not.
bytes calldata userOpSignature;
Expand All @@ -432,19 +431,13 @@ abstract contract ModularAccountBase is
/// Byte indices are [inclusive, exclusive]
/// [25:29] : uint32, encodedDatalength.
/// [29:(29 + encodedDatalength)] : bytes, abi-encoded deferred validation data.
/// [(29 + encodedDataLength):(33 + encodedDataLength)] : uint32, deferredInstallSigLength.
/// [(33 + encodedDataLength):(33 + deferredInstallSigLength + encodedDataLength)] : bytes,
/// [(29 + encodedDataLength):(33 + encodedDataLength)] : uint32, deferredActionSigLength.
/// [(33 + encodedDataLength):(33 + deferredActionSigLength + encodedDataLength)] : bytes,
/// deferred install sig. This is the signature passed to the outer validation decoded earlier.
/// [(33 + deferredInstallSigLength + encodedDataLength):] : bytes, userOpSignature. This is the
/// [(33 + deferredActionSigLength + encodedDataLength):] : bytes, userOpSignature. This is the
/// signature passed to the newly installed deferred validation.
if (isDeferredInstallValidation) {
if (hasDeferredAction) {
// Use outer validation as a 1271 validation, then use the installed validation to validate the rest.
// Check if the outer validation applies to `installValidation`.
_checkIfValidationAppliesSelector(
this.installValidation.selector,
validationFunction, // Treated as sig val
isGlobalValidation ? ValidationCheckingType.GLOBAL : ValidationCheckingType.SELECTOR
);

// Get the length of the abi-encoded `DeferredValidationInstallData` struct.
uint256 encodedDataLength = uint32(bytes4(userOp.signature[25:29]));
Expand All @@ -453,30 +446,30 @@ abstract contract ModularAccountBase is
bytes calldata encodedData = userOp.signature[29:29 + encodedDataLength];

// Get the deferred installation signature length.
uint256 deferredInstallSigLength =
uint256 deferredActionSigLength =
uint32(bytes4(userOp.signature[29 + encodedDataLength:33 + encodedDataLength]));

// Update the UserOp signature to the remaining bytes.
userOpSignature = userOp.signature[33 + encodedDataLength + deferredActionSigLength:];

// Get the deferred installation signature, which is passed to the outer validation to install the
// deferred validation.
bytes calldata deferredInstallSig =
userOp.signature[33 + encodedDataLength:33 + encodedDataLength + deferredInstallSigLength];
bytes calldata deferredActionSig =
userOp.signature[33 + encodedDataLength:33 + encodedDataLength + deferredActionSigLength];

//Validate the signature.
uint48 deadline =
_validateDeferredInstallDataAndSetNonce(validationFunction, encodedData, deferredInstallSig);
(uint48 deadline, ValidationConfig newValidationFunction) = _validateDeferredActionAndSetNonce(
validationFunction, isGlobalValidation, encodedData, deferredActionSig
);
// Update the validation data with the deadline.
validationData = uint256(deadline) << 160;

// Call `installValidation` on the account.
ExecutionLib.callBubbleOnRevertTransient(address(this), 0, encodedData[38:]);

// Update the UserOp signature to the remaining bytes.
userOpSignature = userOp.signature[33 + encodedDataLength + deferredInstallSigLength:];
ExecutionLib.callBubbleOnRevertTransient(address(this), 0, encodedData[63:]);

// Load in the validation that was just installed.
ValidationConfig deferredInstallValidation = ValidationConfig.wrap(bytes25(encodedData[42:67]));
validationFunction = deferredInstallValidation.moduleEntity();
isGlobalValidation = deferredInstallValidation.isGlobal();
validationFunction = newValidationFunction.moduleEntity();
isGlobalValidation = newValidationFunction.isGlobal();
} else {
userOpSignature = userOp.signature[25:];
}
Expand Down Expand Up @@ -509,42 +502,48 @@ abstract contract ModularAccountBase is
}
}

/// @return The deadline of the deferred validation.
function _validateDeferredInstallDataAndSetNonce(
/// @return The deadline of the deferred validation and the validation function to use.
function _validateDeferredActionAndSetNonce(
ModuleEntity sigValidation,
bool isGlobalValidation,
bytes calldata encodedData,
bytes calldata sig
) internal returns (uint48) {
) internal returns (uint48, ValidationConfig) {
// Decode stack vars for the deadline and nonce.
uint256 nonce = uint256(bytes32(encodedData[:32]));
uint48 deadline = uint48(bytes6(encodedData[32:38]));

// Assert the function being called is `installValidation`.
if (bytes4(encodedData[38:42]) != this.installValidation.selector) {
revert DeferredInstallSelectorInvalid();
}
ValidationConfig uoValidation = ValidationConfig.wrap(bytes25(encodedData[38:63]));

// Check if the outer validation applies to the function call
_checkIfValidationAppliesSelector(
bytes4(encodedData[63:67]),
sigValidation,
isGlobalValidation ? ValidationCheckingType.GLOBAL : ValidationCheckingType.SELECTOR
);

// Check that the passed nonce isn't already invalidated.
if (getAccountStorage().deferredInstallNonceUsed[nonce]) {
revert DeferredInstallNonceInvalid();
if (getAccountStorage().deferredActionNonceUsed[nonce]) {
revert DeferredActionNonceInvalid();
}

// Invalidate the nonce.
getAccountStorage().deferredInstallNonceUsed[nonce] = true;
emit DeferredInstallNonceInvalidated(nonce);
getAccountStorage().deferredActionNonceUsed[nonce] = true;
emit DeferredActionNonceInvalidated(nonce);

// Compute the typed data hash to verify the signature over
bytes32 typedDataHash = _computeDeferredValidationInstallTypedDataHash(
encodedData[38:], // The encoded call without the nonce and deadline
encodedData[63:], // The encoded call without the nonce, deadline, and validation function
nonce,
deadline
deadline,
uoValidation
);

if (_isValidSignature(sigValidation, typedDataHash, sig) != _1271_MAGIC_VALUE) {
revert DeferredInstallSignatureInvalid();
revert DeferredActionSignatureInvalid();
}

return deadline;
return (deadline, uoValidation);
}

// To support gas estimation, we don't fail early when the failure is caused by a signature failure
Expand Down Expand Up @@ -1039,9 +1038,10 @@ abstract contract ModularAccountBase is
}

function _computeDeferredValidationInstallTypedDataHash(
bytes calldata encodedInstallCall,
bytes calldata selfCall,
uint256 nonce,
uint48 deadline
uint48 deadline,
ValidationConfig validationFunction
) internal view returns (bytes32) {
// bytes32 result;

Expand All @@ -1052,7 +1052,8 @@ abstract contract ModularAccountBase is
// _INSTALL_VALIDATION_TYPEHASH,
// nonce,
// deadline,
// keccak256(encodedInstallCall)
// validationFunction,
// keccak256(selfCall)
// )
// )

Expand All @@ -1063,22 +1064,27 @@ abstract contract ModularAccountBase is
assembly ("memory-safe") {
// Get the hash of the dynamic-length encoded install call
let fmp := mload(0x40)
calldatacopy(fmp, encodedInstallCall.offset, encodedInstallCall.length)
let installCallHash := keccak256(fmp, encodedInstallCall.length)
calldatacopy(fmp, selfCall.offset, selfCall.length)
let selfCallHash := keccak256(fmp, selfCall.length)

// Compute the struct hash
let ptr := fmp
mstore(ptr, _INSTALL_VALIDATION_TYPEHASH)
mstore(ptr, _DEFERRED_ACTION_TYPEHASH)
ptr := add(ptr, 0x20)
mstore(ptr, nonce)
ptr := add(ptr, 0x20)
// Clear the upper bits of the deadline, in case the caller didn't.
mstore(ptr, and(deadline, 0xffffffff))
ptr := add(ptr, 0x20)
mstore(ptr, installCallHash)
// Clear the lower bits of the validation function, in case the caller didn't.
mstore(
ptr, and(validationFunction, 0xffffffffffffffffffffffffffffffffffffffffffffffffff00000000000000)
)
ptr := add(ptr, 0x20)
mstore(ptr, selfCallHash)

// Compute the struct hash
structHash := keccak256(fmp, 0x80)
structHash := keccak256(fmp, 0xa0)
}

bytes32 typedDataHash = MessageHashUtils.toTypedDataHash(_domainSeparator(), structHash);
Expand Down
Loading

0 comments on commit 1aef4f5

Please sign in to comment.