OwnableRoles

solady/src/auth/OwnableRoles.sol (opens in a new tab)

Contract ownership and access roles management class.

Multiple roles are granted, revoked, accessed via 256-bit bitmaps (binary-OR result) of their flags.

Write Functions

transferOwnership

function transferOwnership(address newOwner) public virtual

Transfers contract ownership to newOwner.

Calling conditions:

• The caller must be the owner of the contract.

renounceOwnership

function renounceOwnership() public virtual

Renounces contract ownership.

Calling conditions:

• The caller must be the owner of the contract.

requestOwnershipHandover

function requestOwnershipHandover() public virtual

Request a two-step ownership handover to the caller.
The request will be automatically expire in 48 hours.

cancelOwnershipHandover

function cancelOwnershipHandover() public virtual

Cancels the two-step ownership handover to the caller, if any.

completeOwnershipHandover

function completeOwnershipHandover(address pendingOwner) public virtual

Allows the owner to complete the two-step ownership handover to pendingOwner.
Reverts if there is no existing ownership handover requested by pendingOwner.

grantRoles

function grantRoles(address user, uint256 roles) public virtual

Allows the owner to grant user roles.
If the user already has a role, then it will be an no-op for the role.

Calling conditions:

• The caller must be the owner of the contract.

revokeRoles

function revokeRoles(address user, uint256 roles) public virtual

Allows the owner to remove user roles.
If the user does not have a role, then it will be an no-op for the role.

Calling conditions:

• The caller must be the owner of the contract.

renounceRoles

function renounceRoles(uint256 roles) public virtual

Allow the caller to remove their own roles.
If the caller does not have a role, then it will be an no-op for the role.

Read-only Functions

owner

function owner() public view virtual returns (address)

Returns the owner of the contract.

ownershipHandoverExpiresAt

function ownershipHandoverExpiresAt(
    address pendingOwner
) public view virtual returns (uint256)

Returns the expiry timestamp for the two-step ownership handover to pendingOwner.

ownershipHandoverValidFor

function ownershipHandoverValidFor() public view returns (uint256);

Returns how long a two-step ownership handover is valid for in seconds.

hasAllRoles

function hasAllRoles(
    address user,
    uint256 roles
) public view virtual returns (bool)

Returns whether user has all of roles.

rolesOf

function rolesOf(address user) public view virtual returns (uint256)

Returns the roles of user.

rolesFromOrdinals

function rolesFromOrdinals(
    uint8[] memory ordinals
) public pure returns (uint256)

Convenience function to return a roles bitmap from the ordinals.
This is meant for frontends like Etherscan, and is therefore not fully optimized.
Not recommended to be called on-chain.

ordinalsFromRoles

function ordinalsFromRoles(
    uint256 roles
) public pure returns (uint8[] memory)

Convenience function to return an array of ordinals from the roles bitmap.
This is meant for frontends like Etherscan, and is therefore not fully optimized.
Not recommended to be called on-chain.

Events

OwnershipTransferred

event OwnershipTransferred(address indexed oldOwner, address indexed newOwner)

The contract ownership is transferred from oldOwner to newOwner.

OwnershipHandoverRequested

event OwnershipHandoverRequested(address indexed pendingOwner)

An ownership handover to pendingOwner has been requested.

OwnershipHandoverCanceled

event OwnershipHandoverCanceled(address indexed pendingOwner)

An ownership handover to pendingOwner has been canceled.

RolesUpdated

event RolesUpdated(address indexed user, uint256 indexed roles)

The user's roles is updated to roles.

Errors

Unauthorized

error Unauthorized()

The caller is not authorized to call the function.

NewOwnerIsZeroAddress

error NewOwnerIsZeroAddress()

The newOwner cannot be the zero address.

NoHandoverRequest

error NoHandoverRequest()

The pendingOwner does not have a valid handover request.