Skip to content

Latest commit

 

History

History
339 lines (284 loc) · 9.6 KB

Ownable.md

File metadata and controls

339 lines (284 loc) · 9.6 KB
Raw

Ownable.sol

View Source: openzeppelin-solidity/contracts/access/Ownable.sol

↗ Extends: Context ↘ Derived Contracts: StoreBase, WithPausability, WithRecovery

Ownable

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. By default, the owner account will be the one that deploys the contract. 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.

Contract Members

Constants & Variables

address private _owner;

Events

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

Modifiers

onlyOwner

Throws if called by any account other than the owner.

modifier onlyOwner() internal

Arguments

Name Type Description

Functions

Initializes the contract setting the deployer as the initial owner.

function () internal nonpayable

Arguments

Name Type Description
Source Code 
constructor() {
        _transferOwnership(_msgSender());
    }

owner

Returns the address of the current owner.

function owner() public view
returns(address)

Arguments

Name Type Description
Source Code 
function owner() public view virtual returns (address) {
        return _owner;
    }

renounceOwnership

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

function renounceOwnership() public nonpayable onlyOwner

Arguments

Name Type Description
Source Code 
function renounceOwnership() public virtual onlyOwner {
        _transferOwnership(address(0));
    }

transferOwnership

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

function transferOwnership(address newOwner) public nonpayable onlyOwner

Arguments

Name Type Description
newOwner address
Source Code 
function transferOwnership(address newOwner) public virtual onlyOwner {
        require(newOwner != address(0), "Ownable: new owner is the zero address");
        _transferOwnership(newOwner);
    }

_transferOwnership

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

function _transferOwnership(address newOwner) internal nonpayable

Arguments

Name Type Description
newOwner address
Source Code 
function _transferOwnership(address newOwner) internal virtual {
        address oldOwner = _owner;
        _owner = newOwner;
        emit OwnershipTransferred(oldOwner, newOwner);
    }

Contracts