OwnableUpgradeable

Inherits: Initializable, ContextUpgradeable

Contract module which provides a basic access control mechanism, where there is an account (an owner) that can be granted exclusive access to specific functions. The initial owner is set to the address provided by the deployer. This can later be changed with transferOwnership. This module is used through inheritance. It will make available the modifier onlyOwner, which can be applied to your functions to restrict their use to the owner.

State Variables

OwnableStorageLocation

bytes32 private constant OwnableStorageLocation = 0x9016d09d72d40fdae2fd8ceac6b6234c7706214fd39c1cd1e609a0528c199300;

Functions

_getOwnableStorage

function _getOwnableStorage() private pure returns (OwnableStorage storage $);

__Ownable_init

Initializes the contract setting the address provided by the deployer as the initial owner.

function __Ownable_init(address initialOwner) internal onlyInitializing;

__Ownable_init_unchained

function __Ownable_init_unchained(address initialOwner) internal onlyInitializing;

onlyOwner

Throws if called by any account other than the owner.

modifier onlyOwner();

owner

Returns the address of the current owner.

function owner() public view virtual returns (address);

_checkOwner

Throws if the sender is not the owner.

function _checkOwner() internal view virtual;

renounceOwnership

Leaves the contract without owner. It will not be possible to call onlyOwner functions. Can only be called by the current owner. NOTE: Renouncing ownership will leave the contract without an owner, thereby disabling any functionality that is only available to the owner.

function renounceOwnership() public virtual onlyOwner;

transferOwnership

Transfers ownership of the contract to a new account (newOwner). Can only be called by the current owner.

function transferOwnership(address newOwner) public virtual onlyOwner;

_transferOwnership

Transfers ownership of the contract to a new account (newOwner). Internal function without access restriction.

function _transferOwnership(address newOwner) internal virtual;

Events

OwnershipTransferred

event OwnershipTransferred(address indexed previousOwner, address indexed newOwner);

Errors

OwnableUnauthorizedAccount

The caller account is not authorized to perform an operation.

error OwnableUnauthorizedAccount(address account);

OwnableInvalidOwner

The owner is not a valid owner account. (eg. address(0))

error OwnableInvalidOwner(address owner);

Structs

OwnableStorage

Note: storage-location: erc7201:openzeppelin.storage.Ownable

struct OwnableStorage {
    address _owner;
}