Skip to content

Commit c9b256c

Browse files
authored
chore: clean up comments (#211)
1 parent 7284028 commit c9b256c

File tree

4 files changed

+11
-12
lines changed

4 files changed

+11
-12
lines changed

src/interfaces/IExecutionHookModule.sol

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ interface IExecutionHookModule is IModule {
1010
/// be more than one.
1111
/// @param sender The caller address.
1212
/// @param value The call value.
13-
/// @param data The calldata sent. For `executeUserOp` calls, hook modules should receive the full msg.data.
13+
/// @param data The calldata sent. For `executeUserOp` calls of validation-associated hooks, hook modules
14+
/// should receive the full calldata.
1415
/// @return Context to pass to a post execution hook, if present. An empty bytes array MAY be returned.
1516
function preExecutionHook(uint32 entityId, address sender, uint256 value, bytes calldata data)
1617
external

src/interfaces/IExecutionModule.sol

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ pragma solidity ^0.8.20;
44
import {IModule} from "./IModule.sol";
55

66
struct ManifestExecutionFunction {
7-
// The selector to install
7+
// The selector to install.
88
bytes4 executionSelector;
99
// If true, the function won't need runtime validation, and can be called by anyone.
1010
bool skipRuntimeValidation;

src/interfaces/IModularAccount.sol

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -80,14 +80,13 @@ interface IModularAccount {
8080
/// @param module The module to install.
8181
/// @param manifest the manifest describing functions to install.
8282
/// @param installData Optional data to be used by the account to handle the initial execution setup. Data
83-
/// encoding
84-
/// is implementation-specific.
83+
/// encoding is implementation-specific.
8584
function installExecution(address module, ExecutionManifest calldata manifest, bytes calldata installData)
8685
external;
8786

8887
/// @notice Uninstall a module from the modular account.
8988
/// @param module The module to uninstall.
90-
/// @param manifest the manifest describing functions to uninstall.
89+
/// @param manifest The manifest describing functions to uninstall.
9190
/// @param uninstallData Optional data to be used by the account to handle the execution uninstallation. Data
9291
/// encoding is implementation-specific.
9392
function uninstallExecution(address module, ExecutionManifest calldata manifest, bytes calldata uninstallData)
@@ -113,8 +112,7 @@ interface IModularAccount {
113112
/// @param uninstallData Optional data to be used by the account to handle the validation uninstallation. Data
114113
/// encoding is implementation-specific.
115114
/// @param hookUninstallData Optional data to be used by the account to handle hook uninstallation. Data
116-
/// encoding
117-
/// is implementation-specific.
115+
/// encoding is implementation-specific.
118116
function uninstallValidation(
119117
ModuleEntity validationFunction,
120118
bytes calldata uninstallData,

src/interfaces/IValidationModule.sol

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ interface IValidationModule is IModule {
1818

1919
/// @notice Run the runtime validation function specified by the `entityId`.
2020
/// @dev To indicate the entire call should revert, the function MUST revert.
21-
/// @param account the account to validate for.
21+
/// @param account The account to validate for.
2222
/// @param entityId An identifier that routes the call to different internal implementations, should there
2323
/// be more than one.
2424
/// @param sender The caller address.
@@ -36,12 +36,12 @@ interface IValidationModule is IModule {
3636

3737
/// @notice Validates a signature using ERC-1271.
3838
/// @dev To indicate the entire call should revert, the function MUST revert.
39-
/// @param account the account to validate for.
39+
/// @param account The account to validate for.
4040
/// @param entityId An identifier that routes the call to different internal implementations, should there
4141
/// be more than one.
42-
/// @param sender the address that sent the ERC-1271 request to the smart account
43-
/// @param hash the hash of the ERC-1271 request
44-
/// @param signature the signature of the ERC-1271 request
42+
/// @param sender The address that sent the ERC-1271 request to the smart account.
43+
/// @param hash The hash of the ERC-1271 request.
44+
/// @param signature The signature of the ERC-1271 request.
4545
/// @return The ERC-1271 `MAGIC_VALUE` if the signature is valid, or 0xFFFFFFFF if invalid.
4646
function validateSignature(
4747
address account,

0 commit comments

Comments
 (0)