OpenZeppelin / OpenZeppelin/docs

TimelockController (v5) documentation

Open
#120 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
MDX
Stars
6
Forks
23
Avg merge
1d 13h
Merged PRs (30d)
4

Description

A few feedbacks (with my current understanding of this doc):

1. Admin is not given to the deployer by default
As per the latest version of TimelockController (v5.0.0), the admin is optional and not given by default to the deployer as described below.
https://github.com/OpenZeppelin/docs/blob/e3504ed22f4138a9aef1dba14c181ff0030d7f82/content/contracts/5.x/access-control.mdx?plain=1#L106

2. No mention of CANCELLER_ROLE
Given the importance of this role, I think it should be detailed in this section in a similar manner as minDelay is detailed.

3. No warning on CANCELLER_ROLE DOS
If a canceller missbehaves, it could cancel all transactions including the ones trying to remove it from the CANCELLER_ROLE. This would result in DOS of the underlying system.
It seems this scenario should be clearly outlined as a warning to inform teams of the importance of securing the canceller(s).

Curious and open to feedbacks on the above

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read content/contracts/5.x/access-control.mdx alongside the linked contracts/governance/TimelockController.sol implementation. Update the TimelockController section to explain the optional admin, CANCELLER_ROLE, and its denial-of-service risk; done means the v5 documentation accurately covers all three points.

Written by the indexing model from the issue text.

Assessment

Tech stack
solidity
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
58/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.