diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md index 371ef47b..bdfd8cc8 100644 --- a/docs/src/SUMMARY.md +++ b/docs/src/SUMMARY.md @@ -9,6 +9,7 @@ - [Oracle](content/core/oracle.md) - [Module](content/core/module.md) + - [AccessControl](content/core/access_control.md) - [Modules](content/modules/README.md) diff --git a/docs/src/content/core/access_control.md b/docs/src/content/core/access_control.md new file mode 100644 index 00000000..58b3545e --- /dev/null +++ b/docs/src/content/core/access_control.md @@ -0,0 +1,21 @@ +# AccessControl + +The access control feature is designed to allow developers to write custom access control logic for users to interact with Prophet. Safeguarding interactions by ensuring only authorized entities can act on behalf of other users. + +## IAccessModule +`IAccessModule` is the interface that defines the functions required for custom access modules. + +See [IAccessModule.sol](/solidity/interfaces/core/modules/access/IAccessModule.sol/interface.IAccessModule.md) for more details. + +## ModuleAccessController +`ModuleAccessController` provides the needed validation for AccessModules. It validates both the approval of the custom AccessModule by the user and that the entitie interacting on behalf of the user has the correct authorization. This abstract contract should be implemented by any module that wants to leverage custom access control functionality. + +See [IModuleAccessController.sol](/solidity/interfaces/core/access/IModuleAccessController.sol/interface.IModuleAccessController.md) for more details. + + +## OracleAccessController +Notice: This contract should NOT be used in the context of Modules as it does provide the correct validation needed for them. + +`OracleAccessController` introduces an easy to use modifier for the Oracle contract that validates authorization for interaction within the Oracle. + +See [IOracleAccessController.sol](/solidity/interfaces/core/access/IOracleAccessController.sol/interface.IOracleAccessController.md) for more details.