Timelock.sol
Methods
DEFAULT_ADMIN_ROLE()
function DEFAULT_ADMIN_ROLE() external view returns (bytes32)
Returns
Name | Type | Description |
---|---|---|
_0 | bytes32 | undefined |
EXECUTOR_ROLE()
function EXECUTOR_ROLE() external view returns (bytes32)
Returns
Name | Type | Description |
---|---|---|
_0 | bytes32 | undefined |
PROPOSER_ROLE()
function PROPOSER_ROLE() external view returns (bytes32)
Returns
Name | Type | Description |
---|---|---|
_0 | bytes32 | undefined |
TIMELOCK_ADMIN_ROLE()
function TIMELOCK_ADMIN_ROLE() external view returns (bytes32)
Returns
Name | Type | Description |
---|---|---|
_0 | bytes32 | undefined |
cancel(bytes32)
function cancel(bytes32 id) external nonpayable
Cancel an operation. Requirements: - the caller must have the 'proposer' role.
Parameters
Name | Type | Description |
---|---|---|
id | bytes32 | undefined |
execute(address,uint256,bytes,bytes32,bytes32)
function execute(address target, uint256 value, bytes data, bytes32 predecessor, bytes32 salt) external payable
Execute an (ready) operation containing a single transaction. Emits a {CallExecuted} event. Requirements: - the caller must have the 'executor' role.
Parameters
Name | Type | Description |
---|---|---|
target | address | undefined |
value | uint256 | undefined |
data | bytes | undefined |
predecessor | bytes32 | undefined |
salt | bytes32 | undefined |
executeBatch(address[],uint256[],bytes[],bytes32,bytes32)
function executeBatch(address[] targets, uint256[] values, bytes[] datas, bytes32 predecessor, bytes32 salt) external payable
Execute an (ready) operation containing a batch of transactions. Emits one {CallExecuted} event per transaction in the batch. Requirements: - the caller must have the 'executor' role.
Parameters
Name | Type | Description |
---|---|---|
targets | address[] | undefined |
values | uint256[] | undefined |
datas | bytes[] | undefined |
predecessor | bytes32 | undefined |
salt | bytes32 | undefined |
getMinDelay()
function getMinDelay() external view returns (uint256 duration)
Returns the minimum delay for an operation to become valid. This value can be changed by executing an operation that calls updateDelay
.
Returns
Name | Type | Description |
---|---|---|
duration | uint256 | undefined |
getRoleAdmin(bytes32)
function getRoleAdmin(bytes32 role) external view returns (bytes32)
Returns the admin role that controls role
. See {grantRole} and {revokeRole}. To change a role's admin, use {_setRoleAdmin}.
Parameters
Name | Type | Description |
---|---|---|
role | bytes32 | undefined |
Returns
Name | Type | Description |
---|---|---|
_0 | bytes32 | undefined |
getTimestamp(bytes32)
function getTimestamp(bytes32 id) external view returns (uint256 timestamp)
Returns the timestamp at with an operation becomes ready (0 for unset operations, 1 for done operations).
Parameters
Name | Type | Description |
---|---|---|
id | bytes32 | undefined |
Returns
Name | Type | Description |
---|---|---|
timestamp | uint256 | undefined |
grantRole(bytes32,address)
function grantRole(bytes32 role, address account) external nonpayable
Grants role
to account
. If account
had not been already granted role
, emits a {RoleGranted} event. Requirements: - the caller must have role
's admin role.
Parameters
Name | Type | Description |
---|---|---|
role | bytes32 | undefined |
account | address | undefined |
hasRole(bytes32,address)
function hasRole(bytes32 role, address account) external view returns (bool)
Returns true
if account
has been granted role
.
Parameters
Name | Type | Description |
---|---|---|
role | bytes32 | undefined |
account | address | undefined |
Returns
Name | Type | Description |
---|---|---|
_0 | bool | undefined |
hashOperation(address,uint256,bytes,bytes32,bytes32)
function hashOperation(address target, uint256 value, bytes data, bytes32 predecessor, bytes32 salt) external pure returns (bytes32 hash)
Returns the identifier of an operation containing a single transaction.
Parameters
Name | Type | Description |
---|---|---|
target | address | undefined |
value | uint256 | undefined |
data | bytes | undefined |
predecessor | bytes32 | undefined |
salt | bytes32 | undefined |
Returns
Name | Type | Description |
---|---|---|
hash | bytes32 | undefined |
hashOperationBatch(address[],uint256[],bytes[],bytes32,bytes32)
function hashOperationBatch(address[] targets, uint256[] values, bytes[] datas, bytes32 predecessor, bytes32 salt) external pure returns (bytes32 hash)
Returns the identifier of an operation containing a batch of transactions.
Parameters
Name | Type | Description |
---|---|---|
targets | address[] | undefined |
values | uint256[] | undefined |
datas | bytes[] | undefined |
predecessor | bytes32 | undefined |
salt | bytes32 | undefined |
Returns
Name | Type | Description |
---|---|---|
hash | bytes32 | undefined |
initialize(uint256,address[],address[])
function initialize(uint256 minDelay, address[] proposers, address[] executors) external nonpayable
Parameters
Name | Type | Description |
---|---|---|
minDelay | uint256 | undefined |
proposers | address[] | undefined |
executors | address[] | undefined |
isOperation(bytes32)
function isOperation(bytes32 id) external view returns (bool pending)
Returns whether an id correspond to a registered operation. This includes both Pending, Ready and Done operations.
Parameters
Name | Type | Description |
---|---|---|
id | bytes32 | undefined |
Returns
Name | Type | Description |
---|---|---|
pending | bool | undefined |
isOperationDone(bytes32)
function isOperationDone(bytes32 id) external view returns (bool done)
Returns whether an operation is done or not.
Parameters
Name | Type | Description |
---|---|---|
id | bytes32 | undefined |
Returns
Name | Type | Description |
---|---|---|
done | bool | undefined |
isOperationPending(bytes32)
function isOperationPending(bytes32 id) external view returns (bool pending)
Returns whether an operation is pending or not.
Parameters
Name | Type | Description |
---|---|---|
id | bytes32 | undefined |
Returns
Name | Type | Description |
---|---|---|
pending | bool | undefined |
isOperationReady(bytes32)
function isOperationReady(bytes32 id) external view returns (bool ready)
Returns whether an operation is ready or not.
Parameters
Name | Type | Description |
---|---|---|
id | bytes32 | undefined |
Returns
Name | Type | Description |
---|---|---|
ready | bool | undefined |
owner()
function owner() external view returns (address)
Returns the address of the current owner.
Returns
Name | Type | Description |
---|---|---|
_0 | address | undefined |
renounceOwnership()
function renounceOwnership() external nonpayable
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.
renounceRole(bytes32,address)
function renounceRole(bytes32 role, address account) external nonpayable
Revokes role
from the calling account. Roles are often managed via {grantRole} and {revokeRole}: this function's purpose is to provide a mechanism for accounts to lose their privileges if they are compromised (such as when a trusted device is misplaced). If the calling account had been revoked role
, emits a {RoleRevoked} event. Requirements: - the caller must be account
.
Parameters
Name | Type | Description |
---|---|---|
role | bytes32 | undefined |
account | address | undefined |
revokeRole(bytes32,address)
function revokeRole(bytes32 role, address account) external nonpayable
Revokes role
from account
. If account
had been granted role
, emits a {RoleRevoked} event. Requirements: - the caller must have role
's admin role.
Parameters
Name | Type | Description |
---|---|---|
role | bytes32 | undefined |
account | address | undefined |
schedule(address,uint256,bytes,bytes32,bytes32,uint256)
function schedule(address target, uint256 value, bytes data, bytes32 predecessor, bytes32 salt, uint256 delay) external nonpayable
Schedule an operation containing a single transaction. Emits a {CallScheduled} event. Requirements: - the caller must have the 'proposer' role.
Parameters
Name | Type | Description |
---|---|---|
target | address | undefined |
value | uint256 | undefined |
data | bytes | undefined |
predecessor | bytes32 | undefined |
salt | bytes32 | undefined |
delay | uint256 | undefined |
scheduleBatch(address[],uint256[],bytes[],bytes32,bytes32,uint256)
function scheduleBatch(address[] targets, uint256[] values, bytes[] datas, bytes32 predecessor, bytes32 salt, uint256 delay) external nonpayable
Schedule an operation containing a batch of transactions. Emits one {CallScheduled} event per transaction in the batch. Requirements: - the caller must have the 'proposer' role.
Parameters
Name | Type | Description |
---|---|---|
targets | address[] | undefined |
values | uint256[] | undefined |
datas | bytes[] | undefined |
predecessor | bytes32 | undefined |
salt | bytes32 | undefined |
delay | uint256 | undefined |
supportsInterface(bytes4)
function supportsInterface(bytes4 interfaceId) external view returns (bool)
See {IERC165-supportsInterface}.
Parameters
Name | Type | Description |
---|---|---|
interfaceId | bytes4 | undefined |
Returns
Name | Type | Description |
---|---|---|
_0 | bool | undefined |
transferOwnership(address)
function transferOwnership(address newOwner) external nonpayable
Transfers ownership of the contract to a new account (newOwner
). Can only be called by the current owner.
Parameters
Name | Type | Description |
---|---|---|
newOwner | address | undefined |
updateDelay(uint256)
function updateDelay(uint256 newDelay) external nonpayable
Changes the minimum timelock duration for future operations. Emits a {MinDelayChange} event. Requirements: - the caller must be the timelock itself. This can only be achieved by scheduling and later executing an operation where the timelock is the target and the data is the ABI-encoded call to this function.
Parameters
Name | Type | Description |
---|---|---|
newDelay | uint256 | undefined |
upgradeTo(address)
function upgradeTo(address newImplementation) external nonpayable
Upgrade the implementation of the proxy to newImplementation
. Calls {_authorizeUpgrade}. Emits an {Upgraded} event.
Parameters
Name | Type | Description |
---|---|---|
newImplementation | address | undefined |
upgradeToAndCall(address,bytes)
function upgradeToAndCall(address newImplementation, bytes data) external payable
Upgrade the implementation of the proxy to newImplementation
, and subsequently execute the function call encoded in data
. Calls {_authorizeUpgrade}. Emits an {Upgraded} event.
Parameters
Name | Type | Description |
---|---|---|
newImplementation | address | undefined |
data | bytes | undefined |
Events
AdminChanged
event AdminChanged(address previousAdmin, address newAdmin)
Parameters
Name | Type | Description |
---|---|---|
previousAdmin | address | undefined |
newAdmin | address | undefined |
BeaconUpgraded
event BeaconUpgraded(address indexed beacon)
Parameters
Name | Type | Description |
---|---|---|
beacon indexed | address | undefined |
CallExecuted
event CallExecuted(bytes32 indexed id, uint256 indexed index, address target, uint256 value, bytes data)
Parameters
Name | Type | Description |
---|---|---|
id indexed | bytes32 | undefined |
index indexed | uint256 | undefined |
target | address | undefined |
value | uint256 | undefined |
data | bytes | undefined |
CallScheduled
event CallScheduled(bytes32 indexed id, uint256 indexed index, address target, uint256 value, bytes data, bytes32 predecessor, uint256 delay)
Parameters
Name | Type | Description |
---|---|---|
id indexed | bytes32 | undefined |
index indexed | uint256 | undefined |
target | address | undefined |
value | uint256 | undefined |
data | bytes | undefined |
predecessor | bytes32 | undefined |
delay | uint256 | undefined |
Cancelled
event Cancelled(bytes32 indexed id)
Parameters
Name | Type | Description |
---|---|---|
id indexed | bytes32 | undefined |
MinDelayChange
event MinDelayChange(uint256 oldDuration, uint256 newDuration)
Parameters
Name | Type | Description |
---|---|---|
oldDuration | uint256 | undefined |
newDuration | uint256 | undefined |
OwnershipTransferred
event OwnershipTransferred(address indexed previousOwner, address indexed newOwner)
Parameters
Name | Type | Description |
---|---|---|
previousOwner indexed | address | undefined |
newOwner indexed | address | undefined |
RoleAdminChanged
event RoleAdminChanged(bytes32 indexed role, bytes32 indexed previousAdminRole, bytes32 indexed newAdminRole)
Parameters
Name | Type | Description |
---|---|---|
role indexed | bytes32 | undefined |
previousAdminRole indexed | bytes32 | undefined |
newAdminRole indexed | bytes32 | undefined |
RoleGranted
event RoleGranted(bytes32 indexed role, address indexed account, address indexed sender)
Parameters
Name | Type | Description |
---|---|---|
role indexed | bytes32 | undefined |
account indexed | address | undefined |
sender indexed | address | undefined |
RoleRevoked
event RoleRevoked(bytes32 indexed role, address indexed account, address indexed sender)
Parameters
Name | Type | Description |
---|---|---|
role indexed | bytes32 | undefined |
account indexed | address | undefined |
sender indexed | address | undefined |
Upgraded
event Upgraded(address indexed implementation)
Parameters
Name | Type | Description |
---|---|---|
implementation indexed | address | undefined |