Transpile f685729

Author: github-actions[bot]

.github/workflows/test.yml

@@ -13,6 +13,8 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
       - uses: actions/setup-node@v3
         with:
           node-version: 12.x
@@ -24,8 +26,14 @@ jobs:
           restore-keys: npm-v2-
       - run: npm ci
         if: steps.cache.outputs.cache-hit != 'true'
+      - run: bash scripts/upgradeable/git-user-config.sh
+      - run: bash scripts/upgradeable/merge-upstream.sh
+        env:
+          REF: 'refs/heads/patches'
+          BASE_REF: HEAD
+        if: ${{ github.base_ref || github.ref }} == 'refs/heads/patches'
       - run: bash scripts/upgradeable/transpile.sh
-        if: github.event_name == 'pull_request'
+        if: ${{ github.base_ref || github.ref }} == 'refs/heads/patches'
       - run: npm run test
         env:
           FORCE_COLOR: 1

CHANGELOG.md

@@ -23,6 +23,10 @@
  * `Initializable`: add an Initialized event that tracks initialized version numbers. ([#3294](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/3294))
  * `ERC2981`: make `royaltiInfo` public to allow super call in overrides. ([#3305](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/3305))
 
+### Upgradeability notice
+
+* `TimelockController`: **(Action needed)** The upgrade from <4.6 to >=4.6 introduces a new `CANCELLER_ROLE` that requires set up to be assignable. After the upgrade, only addresses with this role will have the ability to cancel. Proposers will no longer be able to cancel. Assigning cancellers can be done by an admin (including the timelock itself) once the role admin is set up. To do this, we recommend upgrading to the `TimelockControllerWith46MigrationUpgradeable` contract and then calling the `migrateTo46` function.
+
 ### Breaking changes
 
 * `Governor`: Adds internal virtual `_getVotes` method that must be implemented; this is a breaking change for existing concrete extensions to `Governor`. To fix this on an existing voting module extension, rename `getVotes` to `_getVotes` and add a `bytes memory` argument. ([#3043](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/3043))

contracts/governance/TimelockControllerWith46MigrationUpgradeable.sol

@@ -0,0 +1,54 @@
+// SPDX-License-Identifier: MIT
+// OpenZeppelin Contracts v4.6.0 (governance/TimelockControllerWith46Migration.sol)
+
+pragma solidity ^0.8.0;
+
+import "./TimelockControllerUpgradeable.sol";
+import "../proxy/utils/Initializable.sol";
+
+/**
+ * @dev Extension of the TimelockController that includes an additional
+ * function to migrate from OpenZeppelin Upgradeable Contracts <4.6 to >=4.6.
+ *
+ * This migration is necessary to setup administration rights over the new
+ * `CANCELLER_ROLE`.
+ *
+ * The migration is trustless and can be performed by anyone.
+ *
+ * _Available since v4.6._
+ */
+contract TimelockControllerWith46MigrationUpgradeable is Initializable, TimelockControllerUpgradeable {
+    function __TimelockControllerWith46Migration_init(
+        uint256 minDelay,
+        address[] memory proposers,
+        address[] memory executors
+    ) internal onlyInitializing {
+        __TimelockController_init_unchained(minDelay, proposers, executors);
+    }
+
+    function __TimelockControllerWith46Migration_init_unchained(
+        uint256,
+        address[] memory,
+        address[] memory
+    ) internal onlyInitializing {}
+
+    /**
+     * @dev Migration function. Running it is necessary for upgradeable
+     * instances that were initially setup with code <4.6 and that upgraded
+     * to >=4.6.
+     */
+    function migrateTo46() public virtual {
+        require(
+            getRoleAdmin(PROPOSER_ROLE) == TIMELOCK_ADMIN_ROLE && getRoleAdmin(CANCELLER_ROLE) == DEFAULT_ADMIN_ROLE,
+            "TimelockController: already migrated"
+        );
+        _setRoleAdmin(CANCELLER_ROLE, TIMELOCK_ADMIN_ROLE);
+    }
+
+    /**
+     * @dev This empty reserved space is put in place to allow future versions to add new
+     * variables without shifting down storage in the inheritance chain.
+     * See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
+     */
+    uint256[50] private __gap;
+}

contracts/mocks/WithInit.sol

@@ -19,6 +19,17 @@ contract TimelockControllerUpgradeableWithInit is TimelockControllerUpgradeable
         __TimelockController_init(minDelay, proposers, executors);
     }
 }
+import "../governance/TimelockControllerWith46MigrationUpgradeable.sol";
+
+contract TimelockControllerWith46MigrationUpgradeableWithInit is TimelockControllerWith46MigrationUpgradeable {
+    constructor(
+        uint256 minDelay,
+        address[] memory proposers,
+        address[] memory executors
+    ) payable initializer {
+        __TimelockControllerWith46Migration_init(minDelay, proposers, executors);
+    }
+}
 import "./ERC165CheckerMockUpgradeable.sol";
 
 contract ERC165CheckerMockUpgradeableWithInit is ERC165CheckerMockUpgradeable {

scripts/upgradeable/merge-upstream.sh

@@ -3,6 +3,7 @@
 set -euo pipefail
 
 : "${REF:="$(git rev-parse --symbolic-full-name HEAD)"}"
+: "${BASE_REF:=refs/heads/origin/patches}"
 
 if [[ "$REF" != refs/heads/* ]]; then
   echo "$REF is not a branch" >&2
@@ -16,16 +17,17 @@ set -x
 input="${REF#refs/heads/}"
 upstream="${input#patched/}"
 branch="patched/$upstream"
+base="${BASE_REF}"
 
-git checkout "$branch" 2>/dev/null || git checkout -b "$branch" origin/patches --no-track
+git checkout "$branch" 2>/dev/null || git checkout -b "$branch" "$base" --no-track
 
 git fetch 'https://github.com/OpenZeppelin/openzeppelin-contracts.git' master
-merge_base="$(git merge-base origin/patches FETCH_HEAD)"
+merge_base="$(git merge-base "$base" FETCH_HEAD)"
 
 git fetch 'https://github.com/OpenZeppelin/openzeppelin-contracts.git' "$upstream"
 # Check that patches is not ahead of the upstream branch we're merging.
 if ! git merge-base --is-ancestor "$merge_base" FETCH_HEAD; then
   echo "The patches branch is ahead of $upstream" >&2
   exit 1
 fi
-git merge origin/patches FETCH_HEAD -m "Merge upstream $upstream into $branch"
+git merge "$base" FETCH_HEAD -m "Merge upstream $upstream into $branch"