Skip to main content

Ownable

Git Source

Inherits: Context

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​

_owner​

address private _owner;

Functions​

constructor​

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

constructor(address initialOwner);

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);