NoBey/openzeppelin-contracts
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update TimelockController docs (#2415)

Browse Source 
Co-authored-by: Francisco Giordano <frangio.1@gmail.com>
This commit is contained in:
Nicolás Venturo
2020-11-30 20:14:02 -03:00
committed by GitHub
parent 73c7af102b
commit fa2b204535
1 changed files with 8 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
contracts/access/TimelockController.sol
View File

@ -123,6 +123,8 @@ contract TimelockController is AccessControl {
/** /**
* @dev Returns the minimum delay for an operation to become valid. * @dev Returns the minimum delay for an operation to become valid.
*
* This value can be changed by executing an operation that calls `updateDelay`.
*/ */
function getMinDelay() public view returns (uint256 duration) { function getMinDelay() public view returns (uint256 duration) {
return _minDelay; return _minDelay;
@ -269,9 +271,14 @@ contract TimelockController is AccessControl {
} }
/** /**
* @dev Changes the timelock duration for future operations. * @dev Changes the minimum timelock duration for future operations.
* *
* Emits a {MinDelayChange} event. * 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.
*/ */
function updateDelay(uint256 newDelay) external virtual { function updateDelay(uint256 newDelay) external virtual {
require(msg.sender == address(this), "TimelockController: caller must be timelock"); require(msg.sender == address(this), "TimelockController: caller must be timelock");