fix: add comment about rbacwithadmin being rather powerful (OpenZeppe…

…lin#936) * fix: add comment about rbacwithadmin being rather powerful * fix: move RBACWithAdmin to examples
philosup · Jun 4, 2018 · 2637bd8 · 2637bd8
1 parent 32ec8b5
commit 2637bd8
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/contracts/ownership/rbac/RBACWithAdmin.sol → contracts/examples/RBACWithAdmin.sol b/contracts/ownership/rbac/RBACWithAdmin.sol → contracts/examples/RBACWithAdmin.sol
@@ -1,13 +1,20 @@
 pragma solidity ^0.4.23;
 
-import "./RBAC.sol";
+import "../ownership/rbac/RBAC.sol";
 
 
 /**
  * @title RBACWithAdmin
  * @author Matt Condon (@Shrugs)
  * @dev It's recommended that you define constants in the contract,
  * @dev like ROLE_ADMIN below, to avoid typos.
+ * @dev
+ * @dev NOTE: RBACWithAdmin is probably too expansive and powerful for your
+ * @dev  application; an admin is actually able to change any address to any role
+ * @dev  which is a very large API surface. It's recommended that you follow a strategy
+ * @dev  of strictly defining the abilities of your roles
+ * @dev  and the API-surface of your contract.
+ * @dev  This is just an example for example's sake.
  */
 contract RBACWithAdmin is RBAC {
   /**

diff --git a/contracts/mocks/RBACMock.sol b/contracts/mocks/RBACMock.sol
@@ -1,6 +1,6 @@
 pragma solidity ^0.4.23;
 
-import "../ownership/rbac/RBACWithAdmin.sol";
+import "../examples/RBACWithAdmin.sol";
 
 
 contract RBACMock is RBACWithAdmin {