Skip to main content

IAdminable

Git Source

Title: IAdminable

Contract module that provides a basic access control mechanism, with an admin that can be granted exclusive access to specific functions. The inheriting contract must set the initial admin in the constructor.

Functions​

admin​

The address of the admin account or contract.

function admin() external view returns (address);

transferAdmin​

Transfers the contract admin to a new address.

Notes:

  • Does not revert if the admin is the same.
  • This function can potentially leave the contract without an admin, thereby removing any functionality that is only available to the admin. Requirements:
  • msg.sender must be the contract admin.
function transferAdmin(address newAdmin) external;

Parameters

NameTypeDescription
newAdminaddressThe address of the new admin.

Events​

TransferAdmin​

Emitted when the admin is transferred.

event TransferAdmin(address indexed oldAdmin, address indexed newAdmin);

Parameters

NameTypeDescription
oldAdminaddressThe address of the old admin.
newAdminaddressThe address of the new admin.