Add comment to Modifier.sol

gnosisguild · Oct 9, 2023 · c32130b · c32130b
1 parent 52f47e6
commit c32130b
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/contracts/core/Modifier.sol b/contracts/core/Modifier.sol
@@ -30,6 +30,14 @@ abstract contract Modifier is Module, SignatureChecker, IAvatar {
     /// @dev `setModules()` was already called.
     error SetupModulesAlreadyCalled();
 
+    /*
+    --------------------------------------------------
+    You must override both of the following virtual functions,
+    execTransactionFromModule() and execTransactionFromModuleReturnData().
+    It is recommended that implementations of both functions make use the 
+    onlyModule modifier.
+    */
+
     /// @dev Passes a transaction to the modifier.
     /// @notice Can only be called by enabled modules.
     /// @param to Destination address of module transaction.
@@ -56,6 +64,10 @@ abstract contract Modifier is Module, SignatureChecker, IAvatar {
         Enum.Operation operation
     ) public virtual returns (bool success, bytes memory returnData);
 
+    /*
+    --------------------------------------------------
+    */
+
     modifier moduleOnly() {
         if (modules[msg.sender] == address(0)) {
             if (modules[moduleTxSignedBy()] == address(0)) {