README.adoc 1.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445
  1. = Access Control
  2. [.readme-notice]
  3. NOTE: This document is better viewed at https://docs.openzeppelin.com/contracts/api/access
  4. This directory provides ways to restrict who can access the functions of a contract or when they can do it.
  5. - {AccessManager} is a full-fledged access control solution for smart contract systems. Allows creating and assigning multiple hierarchical roles with execution delays for each account across various contracts.
  6. - {AccessManaged} delegates its access control to an authority that dictates the permissions of the managed contract. It's compatible with an AccessManager as an authority.
  7. - {AccessControl} provides a per-contract role based access control mechanism. Multiple hierarchical roles can be created and assigned each to multiple accounts within the same instance.
  8. - {Ownable} is a simpler mechanism with a single owner "role" that can be assigned to a single account. This simpler mechanism can be useful for quick tests but projects with production concerns are likely to outgrow it.
  9. == Core
  10. {{Ownable}}
  11. {{Ownable2Step}}
  12. {{IAccessControl}}
  13. {{AccessControl}}
  14. == Extensions
  15. {{IAccessControlEnumerable}}
  16. {{AccessControlEnumerable}}
  17. {{IAccessControlDefaultAdminRules}}
  18. {{AccessControlDefaultAdminRules}}
  19. == AccessManager
  20. {{IAuthority}}
  21. {{IAccessManager}}
  22. {{AccessManager}}
  23. {{IAccessManaged}}
  24. {{AccessManaged}}
  25. {{AuthorityUtils}}