Skip to content

docs: fix TimelockController admin, add CANCELLER_ROLE, and DoS warning #143

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
vridhib wants to merge 2 commits into
base: main
Choose a base branch
from
+1 −2
Open

docs: fix TimelockController admin, add CANCELLER_ROLE, and DoS warning #143

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ae6eb6c
docs: correct the TimelockController admin role, add the CANCELLER_RO…
vridhib Apr 7, 2026
859b03e
Merge branch 'main' into fix/timelock-security-warnings
vridhib Jun 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions content/contracts/5.x/access-control.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,8 +110,7 @@ This is the issue the [`TimelockController`](/contracts/5.x/api/governance#Timel
The [`TimelockController`](/contracts/5.x/api/governance#TimelockController) is a proxy that is governed by proposers and executors. When set as the owner/admin/controller of a smart contract, it ensures that whichever maintenance operation is ordered by the proposers is subject to a delay. This delay protects the users of the smart contract by giving them time to review the maintenance operation and exit the system if they consider it is in their best interest to do so.

### Using `TimelockController`

By default, the address that deployed the [`TimelockController`](/contracts/5.x/api/governance#TimelockController) gets administration privileges over the timelock. This role grants the right to assign proposers, executors, and other administrators.
The address that deploys the [`TimelockController`](/contracts/5.x/api/governance#TimelockController) does not automatically receive administration privileges over the timelock. In order for the deployer address to acquire administrative privileges, you must pass the deployer address as the `admin` argument in the constructor. This role grants the right to assign proposers, executors, and other administrators.

The first step in configuring the [`TimelockController`](/contracts/5.x/api/governance#TimelockController) is to assign at least one proposer and one executor. These can be assigned during construction or later by anyone with the administrator role. These roles are not exclusive, meaning an account can have both roles.

Expand Down