Skip to content

Latest commit

 

History

History
366 lines (314 loc) · 12 KB

Ownable.md

File metadata and controls

366 lines (314 loc) · 12 KB
Raw

Ownable.sol

View Source: contracts/openzeppelin/Ownable.sol

↗ Extends: Context ↘ Derived Contracts: AdminRole, BProPriceFeed, FeeSharingCollector, FeeSharingCollectorStorage, FourYearVestingFactory, FourYearVestingStorage, GovernorVault, ILoanToken, ILoanTokenWRBTC, IPriceFeedsExt, IProtocol, LoanTokenBase, Medianizer, MultiSigKeyHolders, OrigingVestingCreator, OriginInvestorsClaim, PausableOz, PriceFeedRSKOracle, PriceFeeds, PriceFeedsMoC, PriceFeedV1PoolOracle, SOV, StakingRewardsStorage, StakingStorageShared, State, TokenSender, VestingFactory, VestingRegistry, VestingRegistry2, VestingRegistry3, VestingStorage

Ownable contract

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.

  • 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

Functions

constructor

Initializes the contract setting the deployer as the initial owner.

function () internal nonpayable
Source Code 
constructor() internal {
        address msgSender = _msgSender();
        _owner = msgSender;
        emit OwnershipTransferred(address(0), msgSender);
    }

owner

Returns the address of the current owner.

function owner() public view
returns(address)
Source Code 
function owner() public view returns (address) {
        return _owner;
    }

isOwner

Returns true if the caller is the current owner.

function isOwner() public view
returns(bool)
Source Code 
function isOwner() public view returns (bool) {
        return _msgSender() == _owner;
    }

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 onlyOwner {
        _transferOwnership(newOwner);
    }

_transferOwnership

Transfers ownership of the contract to a new account (newOwner).

function _transferOwnership(address newOwner) internal nonpayable

Arguments

Name Type Description
newOwner address
Source Code 
function _transferOwnership(address newOwner) internal {
        require(newOwner != address(0), "Ownable: new owner is the zero address");
        emit OwnershipTransferred(_owner, newOwner);
        _owner = newOwner;
    }

Contracts