OwnableAccessControl

Inherits: Ownable

Author: transientlabs.xyz

Single owner, flexible access control mechanics

Can easily be extended by inheriting and applying additional roles

By default, only the owner can grant roles but by inheriting, but you may allow other roles to grant roles by using the internal helper.

State Variables

uint256 private _c;

mapping(uint256 => mapping(bytes32 => mapping(address => bool))) private _roleStatus;

mapping(uint256 => mapping(bytes32 => EnumerableSet.AddressSet)) private _roleMembers;

modifier onlyRole(bytes32 role);

modifier onlyRoleOrOwner(bytes32 role);

constructor() Ownable(msg.sender);

Function to revoke all roles currently present

Increments the _c variables

Requires owner privileges

function revokeAllRoles() external onlyOwner;

Function to renounce role

function renounceRole(bytes32 role) external;

Parameters

Name	Type	Description
`role`	`bytes32`	Bytes32 role created in inheriting contracts

Function to grant/revoke a role to an address

Requires owner to call this function but this may be further extended using the internal helper function in inheriting contracts

function setRole(bytes32 role, address[] memory roleMembers, bool status) external onlyOwner;

Parameters

Name	Type	Description
`role`	`bytes32`	Bytes32 role created in inheriting contracts
`roleMembers`	`address[]`	List of addresses that should have roles attached to them based on `status`
`status`	`bool`	Bool whether to remove or add `roleMembers` to the `role`

Function to see if an address is the owner

function hasRole(bytes32 role, address potentialRoleMember) public view returns (bool);

Parameters

Name	Type	Description
`role`	`bytes32`	Bytes32 role created in inheriting contracts
`potentialRoleMember`	`address`	Address to check for role membership

Function to get role members

function getRoleMembers(bytes32 role) public view returns (address[] memory);

Parameters

Name	Type	Description
`role`	`bytes32`	Bytes32 role created in inheriting contracts

Helper function to set addresses for a role

function _setRole(bytes32 role, address[] memory roleMembers, bool status) internal;

Parameters

Name	Type	Description
`role`	`bytes32`	Bytes32 role created in inheriting contracts
`roleMembers`	`address[]`	List of addresses that should have roles attached to them based on `status`
`status`	`bool`	Bool whether to remove or add `roleMembers` to the `role`

event RoleChange(address indexed from, address indexed user, bool indexed approved, bytes32 role);

event AllRolesRevoked(address indexed from);

Does not have specified role

error NotSpecifiedRole(bytes32 role);

Is not specified role or owner

error NotRoleOrOwner(bytes32 role);