AccessControlEnumerable.sol 3.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687
  1. // SPDX-License-Identifier: MIT
  2. pragma solidity ^0.8.0;
  3. import "./AccessControl.sol";
  4. import "../utils/structs/EnumerableSet.sol";
  5. /**
  6. * @dev External interface of AccessControlEnumerable declared to support ERC165 detection.
  7. */
  8. interface IAccessControlEnumerable {
  9. function getRoleMember(bytes32 role, uint256 index) external view returns (address);
  10. function getRoleMemberCount(bytes32 role) external view returns (uint256);
  11. }
  12. /**
  13. * @dev Extension of {AccessControl} that allows enumerating the members of each role.
  14. */
  15. abstract contract AccessControlEnumerable is IAccessControlEnumerable, AccessControl {
  16. using EnumerableSet for EnumerableSet.AddressSet;
  17. mapping (bytes32 => EnumerableSet.AddressSet) private _roleMembers;
  18. /**
  19. * @dev See {IERC165-supportsInterface}.
  20. */
  21. function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
  22. return interfaceId == type(IAccessControlEnumerable).interfaceId
  23. || super.supportsInterface(interfaceId);
  24. }
  25. /**
  26. * @dev Returns one of the accounts that have `role`. `index` must be a
  27. * value between 0 and {getRoleMemberCount}, non-inclusive.
  28. *
  29. * Role bearers are not sorted in any particular way, and their ordering may
  30. * change at any point.
  31. *
  32. * WARNING: When using {getRoleMember} and {getRoleMemberCount}, make sure
  33. * you perform all queries on the same block. See the following
  34. * https://forum.openzeppelin.com/t/iterating-over-elements-on-enumerableset-in-openzeppelin-contracts/2296[forum post]
  35. * for more information.
  36. */
  37. function getRoleMember(bytes32 role, uint256 index) public view override returns (address) {
  38. return _roleMembers[role].at(index);
  39. }
  40. /**
  41. * @dev Returns the number of accounts that have `role`. Can be used
  42. * together with {getRoleMember} to enumerate all bearers of a role.
  43. */
  44. function getRoleMemberCount(bytes32 role) public view override returns (uint256) {
  45. return _roleMembers[role].length();
  46. }
  47. /**
  48. * @dev Overload {grantRole} to track enumerable memberships
  49. */
  50. function grantRole(bytes32 role, address account) public virtual override {
  51. super.grantRole(role, account);
  52. _roleMembers[role].add(account);
  53. }
  54. /**
  55. * @dev Overload {revokeRole} to track enumerable memberships
  56. */
  57. function revokeRole(bytes32 role, address account) public virtual override {
  58. super.revokeRole(role, account);
  59. _roleMembers[role].remove(account);
  60. }
  61. /**
  62. * @dev Overload {renounceRole} to track enumerable memberships
  63. */
  64. function renounceRole(bytes32 role, address account) public virtual override {
  65. super.renounceRole(role, account);
  66. _roleMembers[role].remove(account);
  67. }
  68. /**
  69. * @dev Overload {_setupRole} to track enumerable memberships
  70. */
  71. function _setupRole(bytes32 role, address account) internal virtual override {
  72. super._setupRole(role, account);
  73. _roleMembers[role].add(account);
  74. }
  75. }