Change Pending to Blocked

contracts/governance/README.adoc

@@ -98,8 +98,9 @@ In a governance system, the {TimelockController} contract is in charge of introd
 * *Operation:* A transaction (or a set of transactions) that is the subject of the timelock. It has to be scheduled by a proposer and executed by an executor. The timelock enforces a minimum delay between the proposition and the execution (see xref:access-control.adoc#operation_lifecycle[operation lifecycle]). If the operation contains multiple transactions (batch mode), they are executed atomically. Operations are identified by the hash of their content.
 * *Operation status:*
 ** *Unset:* An operation that is not part of the timelock mechanism.
-** *Pending:* An operation that has been scheduled but not executed or canceled.
+** *Blocked:* An operation that has been scheduled, before the timer expires.
 ** *Ready:* An operation that has been scheduled, after the timer expires.
+** *Pending:* An operation that is either blocked or ready.
 ** *Done:* An operation that has been executed.
 * *Predecessor*: An (optional) dependency between operations. An operation can depend on another operation (its predecessor), forcing the execution order of these two operations.
 * *Role*:

contracts/governance/TimelockController.sol

@@ -34,7 +34,7 @@ contract TimelockController is AccessControl, ERC721Holder, ERC1155Holder {
 
     enum OperationState {
         Unset,
-        Pending,
+        Blocked,
         Ready,
         Done
     }
@@ -170,11 +170,10 @@ contract TimelockController is AccessControl, ERC721Holder, ERC1155Holder {
     }
 
     /**
-     * @dev Returns whether an operation is pending or not. Note that a "pending" operation may also be "ready".
+     * @dev Returns whether an operation is waitinf for expiration. Note that a "blocked" operation is also "pending".
      */
-    function isOperationPending(bytes32 id) public view virtual returns (bool) {
-        OperationState state = getOperationState(id);
-        return state == OperationState.Pending || state == OperationState.Ready;
+    function isOperationBlocked(bytes32 id) public view virtual returns (bool) {
+        return getOperationState(id) == OperationState.Blocked;
     }
 
     /**
@@ -184,6 +183,14 @@ contract TimelockController is AccessControl, ERC721Holder, ERC1155Holder {
         return getOperationState(id) == OperationState.Ready;
     }
 
+    /**
+     * @dev Returns whether an operation is pending or not. Note that a "pending" operation may also be "ready".
+     */
+    function isOperationPending(bytes32 id) public view virtual returns (bool) {
+        OperationState state = getOperationState(id);
+        return state == OperationState.Blocked || state == OperationState.Ready;
+    }
+
     /**
      * @dev Returns whether an operation is done or not.
      */
@@ -209,7 +216,7 @@ contract TimelockController is AccessControl, ERC721Holder, ERC1155Holder {
         } else if (timestamp == _DONE_TIMESTAMP) {
             return OperationState.Done;
         } else if (timestamp > block.timestamp) {
-            return OperationState.Pending;
+            return OperationState.Blocked;
         } else {
             return OperationState.Ready;
         }
@@ -330,8 +337,8 @@ contract TimelockController is AccessControl, ERC721Holder, ERC1155Holder {
      * - the caller must have the 'canceller' role.
      */
     function cancel(bytes32 id) public virtual onlyRole(CANCELLER_ROLE) {
-        if (getOperationState(id) != OperationState.Pending) {
-            revert TimelockUnexpectedOperationState(id, OperationState.Pending);
+        if (!isOperationPending(id)) {
+            revert TimelockUnexpectedOperationState(id, OperationState.Blocked);
         }
         delete _timestamps[id];
 
@@ -413,10 +420,10 @@ contract TimelockController is AccessControl, ERC721Holder, ERC1155Holder {
      * @dev Checks before execution of an operation's calls.
      */
     function _beforeCall(bytes32 id, bytes32 predecessor) private view {
-        if (getOperationState(id) != OperationState.Ready) {
+        if (!isOperationReady(id)) {
             revert TimelockUnexpectedOperationState(id, OperationState.Ready);
         }
-        if (predecessor != bytes32(0) && getOperationState(predecessor) != OperationState.Done) {
+        if (predecessor != bytes32(0) && !isOperationDone(predecessor)) {
             revert TimelockUnexecutedPredecessor(predecessor);
         }
     }