TimelockController (v5) documentation
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 58/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Quiet
- Tech stack
- solidity
- Domain
- documentation
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.
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
- Dominant language
- MDX
- Stars
- 6
- Forks
- 23
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 4
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from OpenZeppelin/docs
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
OpenZeppelin/docs#134 · 1 comment ·
-
OpenZeppelin/docs#238 · 1 assignee ·
-
documentation
Difficulty 5/5 Over a week Newbie friendliness 28/100
OpenZeppelin/docs#236 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 68/100
OpenZeppelin/docs#231 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 35/100
OpenZeppelin/docs#199 ·
All issues in OpenZeppelin/docs
Similar issues
-
Area: Excel support
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
orbeon/orbeon-forms#7893 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
docToolchain/docToolchain#1705 ·
-
kb-infra-drift
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
OCHA-DAP/ds-knowledge-base#653 · 1 comment ·
-
area/dev-productivity area/disaster-recovery area/ipcei kind/enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
namespace operations
Difficulty 1/5 Under an hour Newbie friendliness 90/100
EclipseFdn/open-vsx.org#13419 ·