add some comment to SENTINEL_OWNERS (#804)

dodger213 · Aug 1, 2024 · d87d8f2 · d87d8f2
1 parent 6decf6c
commit d87d8f2
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/contracts/base/ModuleManager.sol b/contracts/base/ModuleManager.sol
@@ -56,6 +56,9 @@ abstract contract BaseModuleGuard is IModuleGuard {
  * @author Richard Meissner - @rmeissner
  */
 abstract contract ModuleManager is SelfAuthorized, Executor, IModuleManager {
+    // SENTINEL_MODULES is used to traverse `modules`, so that:
+    //      1. `modules[SENTINEL_MODULES]` contains the first module
+    //      2. `modules[last_module]` points back to SENTINEL_MODULES
     address internal constant SENTINEL_MODULES = address(0x1);
 
     // keccak256("module_manager.module_guard.address")

diff --git a/contracts/base/OwnerManager.sol b/contracts/base/OwnerManager.sol
@@ -11,6 +11,9 @@ import {IOwnerManager} from "../interfaces/IOwnerManager.sol";
  * @author Richard Meissner - @rmeissner
  */
 abstract contract OwnerManager is SelfAuthorized, IOwnerManager {
+    // SENTINEL_OWNERS is used to traverse `owners`, so that:
+    //      1. `owners[SENTINEL_OWNERS]` contains the first owner
+    //      2. `owners[last_owner]` points back to SENTINEL_OWNERS
     address internal constant SENTINEL_OWNERS = address(0x1);
 
     mapping(address => address) internal owners;