feat : more tracking in AccessManagerEnumerable

snapshots/Hub.Operations.json

@@ -4,7 +4,7 @@
   "draw": "105931",
   "eliminateDeficit: full": "59781",
   "eliminateDeficit: partial": "69429",
-  "mintFeeShares": "86130",
+  "mintFeeShares": "86218",
   "payFee": "72302",
   "refreshPremium": "71999",
   "remove: full": "76993",

src/access/AccessManagerEnumerable.sol

@@ -12,15 +12,77 @@ import {IAccessManagerEnumerable} from 'src/access/interfaces/IAccessManagerEnum
 contract AccessManagerEnumerable is AccessManager, IAccessManagerEnumerable {
   using EnumerableSet for EnumerableSet.AddressSet;
   using EnumerableSet for EnumerableSet.Bytes32Set;
+  using EnumerableSet for EnumerableSet.UintSet;
+
+  /// @dev Set of all role identifiers.
+  EnumerableSet.UintSet private _rolesSet;
+
+  /// @dev Set of all admin role identifiers.
+  EnumerableSet.UintSet private _adminRolesSet;
 
   /// @dev Map of role identifiers to their respective member sets.
   mapping(uint64 roleId => EnumerableSet.AddressSet) private _roleMembers;
 
+  /// @dev Map of admin role identifiers to their respective role identifier sets.
+  mapping(uint64 roleId => EnumerableSet.UintSet) private _adminOfRoles;
+
+  /// @dev Map of role identifiers to their respective target contract addresses.
+  mapping(uint64 roleId => EnumerableSet.AddressSet) private _roleTargets;
+
+  /// @dev Map of target contract addresses and function selectors to their assigned role identifier.
+  mapping(address target => mapping(bytes4 selector => uint64 roleId)) private _targetSelectorRoles;
+
   /// @dev Map of role identifiers and target contract addresses to their respective set of function selectors.
   mapping(uint64 roleId => mapping(address target => EnumerableSet.Bytes32Set))
-    private _roleTargetFunctions;
+    private _roleTargetSelectors;
+
+  /// @dev Constructor.
+  /// @param initialAdmin_ The address of the initial admin.
+  constructor(address initialAdmin_) AccessManager(initialAdmin_) {
+    // Track the ADMIN_ROLE by default.
+    // (already tracked as a default role via AccessManager constructor)
+    _adminRolesSet.add(ADMIN_ROLE);
+  }
+
+  /// @inheritdoc IAccessManagerEnumerable
+  function getRole(uint256 index) external view returns (uint64) {
+    return uint64(_rolesSet.at(index));
+  }
+
+  /// @inheritdoc IAccessManagerEnumerable
+  function getRoleCount() external view returns (uint256) {
+    return _rolesSet.length();
+  }
+
+  /// @inheritdoc IAccessManagerEnumerable
+  function getRoles(uint256 start, uint256 end) external view returns (uint64[] memory) {
+    uint256[] memory listedRoles = _rolesSet.values(start, end);
+    uint64[] memory roles;
+    assembly ('memory-safe') {
+      roles := listedRoles
+    }
+    return roles;
+  }
 
-  constructor(address initialAdmin_) AccessManager(initialAdmin_) {}
+  /// @inheritdoc IAccessManagerEnumerable
+  function getAdminRole(uint256 index) external view returns (uint64) {
+    return uint64(_adminRolesSet.at(index));
+  }
+
+  /// @inheritdoc IAccessManagerEnumerable
+  function getAdminRoleCount() external view returns (uint256) {
+    return _adminRolesSet.length();
+  }
+
+  /// @inheritdoc IAccessManagerEnumerable
+  function getAdminRoles(uint256 start, uint256 end) external view returns (uint64[] memory) {
+    uint256[] memory listedAdminRoles = _adminRolesSet.values(start, end);
+    uint64[] memory adminRoles;
+    assembly ('memory-safe') {
+      adminRoles := listedAdminRoles
+    }
+    return adminRoles;
+  }
 
   /// @inheritdoc IAccessManagerEnumerable
   function getRoleMember(uint64 roleId, uint256 index) external view returns (address) {
@@ -42,38 +104,122 @@ contract AccessManagerEnumerable is AccessManager, IAccessManagerEnumerable {
   }
 
   /// @inheritdoc IAccessManagerEnumerable
-  function getRoleTargetFunction(
+  function getAdminOfRole(uint64 adminRoleId, uint256 index) external view returns (uint64) {
+    return uint64(_adminOfRoles[adminRoleId].at(index));
+  }
+
+  /// @inheritdoc IAccessManagerEnumerable
+  function getAdminOfRoleCount(uint64 adminRoleId) external view returns (uint256) {
+    return _adminOfRoles[adminRoleId].length();
+  }
+
+  /// @inheritdoc IAccessManagerEnumerable
+  function getAdminOfRoles(
+    uint64 adminRoleId,
+    uint256 start,
+    uint256 end
+  ) external view returns (uint64[] memory) {
+    uint256[] memory listedRoles = _adminOfRoles[adminRoleId].values(start, end);
+    uint64[] memory roles;
+    assembly ('memory-safe') {
+      roles := listedRoles
+    }
+    return roles;
+  }
+
+  /// @inheritdoc IAccessManagerEnumerable
+  function getRoleTarget(uint64 roleId, uint256 index) external view returns (address) {
+    return _roleTargets[roleId].at(index);
+  }
+
+  /// @inheritdoc IAccessManagerEnumerable
+  function getRoleTargetCount(uint64 roleId) external view returns (uint256) {
+    return _roleTargets[roleId].length();
+  }
+
+  /// @inheritdoc IAccessManagerEnumerable
+  function getRoleTargets(
+    uint64 roleId,
+    uint256 start,
+    uint256 end
+  ) external view returns (address[] memory) {
+    return _roleTargets[roleId].values(start, end);
+  }
+
+  /// @inheritdoc IAccessManagerEnumerable
+  function getRoleTargetSelector(
     uint64 roleId,
     address target,
     uint256 index
   ) external view returns (bytes4) {
-    return bytes4(_roleTargetFunctions[roleId][target].at(index));
+    return bytes4(_roleTargetSelectors[roleId][target].at(index));
   }
 
   /// @inheritdoc IAccessManagerEnumerable
-  function getRoleTargetFunctionCount(
+  function getRoleTargetSelectorCount(
     uint64 roleId,
     address target
   ) external view returns (uint256) {
-    return _roleTargetFunctions[roleId][target].length();
+    return _roleTargetSelectors[roleId][target].length();
   }
 
   /// @inheritdoc IAccessManagerEnumerable
-  function getRoleTargetFunctions(
+  function getRoleTargetSelectors(
     uint64 roleId,
     address target,
     uint256 start,
     uint256 end
   ) external view returns (bytes4[] memory) {
-    bytes32[] memory targetFunctions = _roleTargetFunctions[roleId][target].values(start, end);
+    bytes32[] memory targetFunctions = _roleTargetSelectors[roleId][target].values(start, end);
     bytes4[] memory targetFunctionSelectors;
     assembly ('memory-safe') {
       targetFunctionSelectors := targetFunctions
     }
     return targetFunctionSelectors;
   }
 
-  /// @dev Override AccessManager `_grantRole` function to track role members.
+  /// @dev Tracks all role identifiers when a new role is created.
+  function _trackRole(uint64 roleId) internal {
+    _rolesSet.add(uint256(roleId));
+  }
+
+  /// @dev Tracks all admin role identifiers when a new admin role is set.
+  function _trackAdminRole(uint64 roleId, uint64 admin) internal {
+    _adminRolesSet.add(uint256(admin));
+    uint64 oldAdmin = getRoleAdmin(roleId);
+    _adminOfRoles[oldAdmin].remove(uint256(roleId));
+    _adminOfRoles[admin].add(uint256(roleId));
+  }
+
+  /// @dev Tracks all targets where a selector was assigned to a role.
+  function _trackRoleTarget(uint64 roleId, address target, bytes4 selector) internal {
+    uint64 oldRole = _targetSelectorRoles[target][selector];
+    if (oldRole == roleId) {
+      return;
+    }
+    if (oldRole != ADMIN_ROLE && _roleTargetSelectors[oldRole][target].length() == 0) {
+      _roleTargets[oldRole].remove(target);
+    }
+    if (roleId != ADMIN_ROLE) {
+      _roleTargets[roleId].add(target);
+    }
+    _targetSelectorRoles[target][selector] = roleId;
+  }
+
+  /// @dev Override AccessManager `_setRoleAdmin` function to track created roles.
+  function _setRoleAdmin(uint64 roleId, uint64 admin) internal override {
+    _trackRole(roleId);
+    _trackAdminRole(roleId, admin);
+    super._setRoleAdmin(roleId, admin);
+  }
+
+  /// @dev Override AccessManager `_setRoleGuardian` function to track created roles.
+  function _setRoleGuardian(uint64 roleId, uint64 guardian) internal override {
+    _trackRole(roleId);
+    super._setRoleGuardian(roleId, guardian);
+  }
+
+  /// @dev Override AccessManager `_grantRole` function to track roles' membership.
   function _grantRole(
     uint64 roleId,
     address account,
@@ -82,12 +228,13 @@ contract AccessManagerEnumerable is AccessManager, IAccessManagerEnumerable {
   ) internal override returns (bool) {
     bool granted = super._grantRole(roleId, account, grantDelay, executionDelay);
     if (granted) {
+      _trackRole(roleId);
       _roleMembers[roleId].add(account);
     }
     return granted;
   }
 
-  /// @dev Override AccessManager `_revokeRole` function to remove from tracked role members.
+  /// @dev Override AccessManager `_revokeRole` function to remove from tracked roles' membership.
   function _revokeRole(uint64 roleId, address account) internal override returns (bool) {
     bool revoked = super._revokeRole(roleId, account);
     if (revoked) {
@@ -105,10 +252,12 @@ contract AccessManagerEnumerable is AccessManager, IAccessManagerEnumerable {
     uint64 oldRoleId = getTargetFunctionRole(target, selector);
     super._setTargetFunctionRole(target, selector, roleId);
     if (oldRoleId != ADMIN_ROLE) {
-      _roleTargetFunctions[oldRoleId][target].remove(bytes32(selector));
+      _roleTargetSelectors[oldRoleId][target].remove(bytes32(selector));
     }
     if (roleId != ADMIN_ROLE) {
-      _roleTargetFunctions[roleId][target].add(bytes32(selector));
+      _roleTargetSelectors[roleId][target].add(bytes32(selector));
     }
+    // also track the target under the role (will be added if not already present)
+    _trackRoleTarget(roleId, target, selector);
   }
 }

src/access/interfaces/IAccessManagerEnumerable.sol

@@ -8,6 +8,37 @@ import {IAccessManager} from 'src/dependencies/openzeppelin/IAccessManager.sol';
 /// @author Aave Labs
 /// @notice Interface for AccessManagerEnumerable extension.
 interface IAccessManagerEnumerable is IAccessManager {
+  /// @notice Returns the identifier of the role at a specified index.
+  /// @param index The index in the role list.
+  /// @return The identifier of the role.
+  function getRole(uint256 index) external view returns (uint64);
+
+  /// @notice Returns the total number of existing roles.
+  /// @dev Does not account for the built-in `PUBLIC_ROLE` role.
+  /// @return The number of roles.
+  function getRoleCount() external view returns (uint256);
+
+  /// @notice Returns the list of role identifiers between the specified indexes.
+  /// @param start The starting index for the role list.
+  /// @param end The ending index for the role list.
+  /// @return The list of role identifiers.
+  function getRoles(uint256 start, uint256 end) external view returns (uint64[] memory);
+
+  /// @notice Returns the identifier of the admin role at a specified index.
+  /// @param index The index in the admin role list.
+  /// @return The identifier of the admin role.
+  function getAdminRole(uint256 index) external view returns (uint64);
+
+  /// @notice Returns the total number of existing admin roles.
+  /// @return The number of admin roles.
+  function getAdminRoleCount() external view returns (uint256);
+
+  /// @notice Returns the list of admin role identifiers between the specified indexes.
+  /// @param start The starting index for the admin role list.
+  /// @param end The ending index for the admin role list.
+  /// @return The list of admin role identifiers.
+  function getAdminRoles(uint256 start, uint256 end) external view returns (uint64[] memory);
+
   /// @notice Returns the address of the role member at a specified index.
   /// @param roleId The identifier of the role.
   /// @param index The index in the role member list.
@@ -19,7 +50,7 @@ interface IAccessManagerEnumerable is IAccessManager {
   /// @return The number of members for the role.
   function getRoleMemberCount(uint64 roleId) external view returns (uint256);
 
-  /// @notice Returns the list of members for a specified role.
+  /// @notice Returns the list of members for a specified role between the specified indexes.
   /// @param roleId The identifier of the role.
   /// @param start The starting index for the member list.
   /// @param end The ending index for the member list.
@@ -30,12 +61,56 @@ interface IAccessManagerEnumerable is IAccessManager {
     uint256 end
   ) external view returns (address[] memory);
 
+  /// @notice Returns the role identifier of the listed roles for a specified admin role at a specified index.
+  /// @param adminRoleId The identifier of the admin role.
+  /// @param index The index in the admin controlled role list.
+  /// @return The indentifier of the role.
+  function getAdminOfRole(uint64 adminRoleId, uint256 index) external view returns (uint64);
+
+  /// @notice Returns the number of members for a specified role.
+  /// @param adminRoleId The identifier of the admin role.
+  /// @return The number of members for the role.
+  function getAdminOfRoleCount(uint64 adminRoleId) external view returns (uint256);
+
+  /// @notice Returns the list of role identifiers controlled by a specified admin role between the specified indexes.
+  /// @param adminRoleId The identifier of the admin role.
+  /// @param start The starting index for the admin controlled role list.
+  /// @param end The ending index for the admin controlled role list.
+  /// @return The list of admin controlled role indentifiers for the admin role.
+  function getAdminOfRoles(
+    uint64 adminRoleId,
+    uint256 start,
+    uint256 end
+  ) external view returns (uint64[] memory);
+
+  /// @notice Returns the address of the target contract for a specified role and index.
+  /// @param roleId The identifier of the role.
+  /// @param index The index in the role target list.
+  /// @return The address of the target contract.
+  function getRoleTarget(uint64 roleId, uint256 index) external view returns (address);
+
+  /// @notice Returns the number of target contracts for a specified role.
+  /// @param roleId The identifier of the role.
+  /// @return The number of target contracts for the role.
+  function getRoleTargetCount(uint64 roleId) external view returns (uint256);
+
+  /// @notice Returns the list of target contracts for a specified role between the specified indexes.
+  /// @param roleId The identifier of the role.
+  /// @param start The starting index for the role target list.
+  /// @param end The ending index for the role target list.
+  /// @return The list of target contracts for the role.
+  function getRoleTargets(
+    uint64 roleId,
+    uint256 start,
+    uint256 end
+  ) external view returns (address[] memory);
+
   /// @notice Returns the function selector assigned to a given role at the specified index.
   /// @param roleId The identifier of the role.
   /// @param target The address of the target contract.
   /// @param index The index in the role member list.
   /// @return The selector at the index.
-  function getRoleTargetFunction(
+  function getRoleTargetSelector(
     uint64 roleId,
     address target,
     uint256 index
@@ -45,7 +120,7 @@ interface IAccessManagerEnumerable is IAccessManager {
   /// @param roleId The identifier of the role.
   /// @param target The address of the target contract.
   /// @return The number of selectors assigned to the role.
-  function getRoleTargetFunctionCount(
+  function getRoleTargetSelectorCount(
     uint64 roleId,
     address target
   ) external view returns (uint256);
@@ -56,7 +131,7 @@ interface IAccessManagerEnumerable is IAccessManager {
   /// @param start The starting index for the selector list.
   /// @param end The ending index for the selector list.
   /// @return The list of selectors assigned to the role.
-  function getRoleTargetFunctions(
+  function getRoleTargetSelectors(
     uint64 roleId,
     address target,
     uint256 start,