-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* fix: npm link * docs: access control * docs: fix IAccessModule link * docs: fix IAccessModule link
- Loading branch information
Showing
2 changed files
with
22 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |