docs(l2): add timelock contract docs#5685
Merged
ManuelBilbao merged 64 commits intomainfrom Jan 7, 2026
Merged
Conversation
Lines of code reportTotal lines added: Detailed view |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive documentation for the Timelock.sol contract, which serves as an access control layer for the OnChainProposer contract by managing role-based permissions and scheduled operations with delays.
Key Changes
- Introduces documentation explaining the Timelock contract's role architecture (Sequencers, Governance, and Security Council)
- Documents core functionalities including scheduling, executing, and canceling operations
- Provides guidance on operation ID collision handling and cancellation procedures
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
ManuelBilbao
approved these changes
Jan 6, 2026
Contributor
ManuelBilbao
left a comment
There was a problem hiding this comment.
Just a few nit comments
Co-authored-by: Manuel Iñaki Bilbao <manuel.bilbao@lambdaclass.com>
Co-authored-by: Manuel Iñaki Bilbao <manuel.bilbao@lambdaclass.com>
tomip01
approved these changes
Jan 7, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
Description
Add docs for the
Timelock.solcontract