Timelock.sol

Methods

DEFAULT_ADMIN_ROLE()

Solidity

function DEFAULT_ADMIN_ROLE() external view returns (bytes32)

Returns

Name	Type	Description
_0	bytes32	undefined

EXECUTOR_ROLE()

Solidity

function EXECUTOR_ROLE() external view returns (bytes32)

Returns

Name	Type	Description
_0	bytes32	undefined

PROPOSER_ROLE()

Solidity

function PROPOSER_ROLE() external view returns (bytes32)

Returns

Name	Type	Description
_0	bytes32	undefined

TIMELOCK_ADMIN_ROLE()

Solidity

function TIMELOCK_ADMIN_ROLE() external view returns (bytes32)

Returns

Name	Type	Description
_0	bytes32	undefined

cancel(bytes32)

Solidity

function cancel(bytes32 id) external nonpayable

Details

Cancel an operation. Requirements: - the caller must have the 'proposer' role.

Parameters

Name	Type	Description
id	bytes32	undefined

execute(address,uint256,bytes,bytes32,bytes32)

Solidity

function execute(address target, uint256 value, bytes data, bytes32 predecessor, bytes32 salt) external payable

Details

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)

Solidity

function executeBatch(address[] targets, uint256[] values, bytes[] datas, bytes32 predecessor, bytes32 salt) external payable

Details

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

Solidity

function getMinDelay() external view returns (uint256 duration)

Details

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)

Solidity

function getRoleAdmin(bytes32 role) external view returns (bytes32)

Details

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)

Solidity

function getTimestamp(bytes32 id) external view returns (uint256 timestamp)

Details

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)

Solidity

function grantRole(bytes32 role, address account) external nonpayable

Details

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)

Solidity

function hasRole(bytes32 role, address account) external view returns (bool)

Details

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)

Solidity

function hashOperation(address target, uint256 value, bytes data, bytes32 predecessor, bytes32 salt) external pure returns (bytes32 hash)

Details

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)

Solidity

function hashOperationBatch(address[] targets, uint256[] values, bytes[] datas, bytes32 predecessor, bytes32 salt) external pure returns (bytes32 hash)

Details

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[])

Solidity

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)

Solidity

function isOperation(bytes32 id) external view returns (bool pending)

Details

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)

Solidity

function isOperationDone(bytes32 id) external view returns (bool done)

Details

Returns whether an operation is done or not.

Parameters

Name	Type	Description
id	bytes32	undefined

Returns

Name	Type	Description
done	bool	undefined

isOperationPending(bytes32)

Solidity

function isOperationPending(bytes32 id) external view returns (bool pending)

Details

Returns whether an operation is pending or not.

Parameters

Name	Type	Description
id	bytes32	undefined

Returns

Name	Type	Description
pending	bool	undefined

isOperationReady(bytes32)

Solidity

function isOperationReady(bytes32 id) external view returns (bool ready)

Details

Returns whether an operation is ready or not.

Parameters

Name	Type	Description
id	bytes32	undefined

Returns

Name	Type	Description
ready	bool	undefined

owner()

Solidity

function owner() external view returns (address)

Details

Returns the address of the current owner.

Returns

Name	Type	Description
_0	address	undefined

renounceOwnership()

Solidity

function renounceOwnership() external nonpayable

Details

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)

Solidity

function renounceRole(bytes32 role, address account) external nonpayable

Details

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)

Solidity

function revokeRole(bytes32 role, address account) external nonpayable

Details

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)

Solidity

function schedule(address target, uint256 value, bytes data, bytes32 predecessor, bytes32 salt, uint256 delay) external nonpayable

Details

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)

Solidity

function scheduleBatch(address[] targets, uint256[] values, bytes[] datas, bytes32 predecessor, bytes32 salt, uint256 delay) external nonpayable

Details

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)

Solidity

function supportsInterface(bytes4 interfaceId) external view returns (bool)

Details

See {IERC165-supportsInterface}.

Parameters

Name	Type	Description
interfaceId	bytes4	undefined

Returns

Name	Type	Description
_0	bool	undefined

transferOwnership(address)

Solidity

function transferOwnership(address newOwner) external nonpayable

Details

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)

Solidity

function updateDelay(uint256 newDelay) external nonpayable

Details

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)

Solidity

function upgradeTo(address newImplementation) external nonpayable

Details

Upgrade the implementation of the proxy to newImplementation. Calls {_authorizeUpgrade}. Emits an {Upgraded} event.

Parameters

Name	Type	Description
newImplementation	address	undefined

upgradeToAndCall(address,bytes)

Solidity

function upgradeToAndCall(address newImplementation, bytes data) external payable

Details

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

Solidity

event AdminChanged(address previousAdmin, address newAdmin)

Parameters

Name	Type	Description
previousAdmin	address	undefined
newAdmin	address	undefined

BeaconUpgraded

Solidity

event BeaconUpgraded(address indexed beacon)

Parameters

Name	Type	Description
beacon indexed	address	undefined

CallExecuted

Solidity

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

Solidity

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

Solidity

event Cancelled(bytes32 indexed id)

Parameters

Name	Type	Description
id indexed	bytes32	undefined

MinDelayChange

Solidity

event MinDelayChange(uint256 oldDuration, uint256 newDuration)

Parameters

Name	Type	Description
oldDuration	uint256	undefined
newDuration	uint256	undefined

OwnershipTransferred

Solidity

event OwnershipTransferred(address indexed previousOwner, address indexed newOwner)

Parameters

Name	Type	Description
previousOwner indexed	address	undefined
newOwner indexed	address	undefined

RoleAdminChanged

Solidity

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

Solidity

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

Solidity

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

Solidity

event Upgraded(address indexed implementation)

Parameters

Name	Type	Description
implementation indexed	address	undefined