Skip to content

docs(l2): add timelock contract docs #5685

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

Jump to bottom
Merged
ManuelBilbao merged 64 commits into from
Jan 7, 2026
Merged

docs(l2): add timelock contract docs #5685

ManuelBilbao merged 64 commits into from
Jan 7, 2026

Conversation

@JereSalo
Copy link
Contributor

@JereSalo JereSalo commented Dec 18, 2025

Motivation

Description

Add docs for the Timelock.sol contract

JereSalo and others added 27 commits December 16, 2025 14:08
@JereSalo
timelock first steps
ac5726d
@JereSalo
improve some stuff and add comments
5e341dd
@JereSalo
add one more comment about security council
6138e29
@JereSalo
Deploy timelock contract and make it compile (not tested)
a2b631c
@JereSalo
remove comments
06429f5
@JereSalo
commit and verify batches to Timelock instead of OnChainProposer
75968ed
@JereSalo
add pause and unpause functions
ea206cb
@JereSalo
change mindelay to 30 seconds for testing
4e2ab15
@JereSalo
add emergency execution for security council
d390d97
@JereSalo
remove initialization of bridge address and transfer of ownership
6516788
@JereSalo
run cargo fmt
3545409
@JereSalo
fix solidity lint in Timelock
6a41d67
@JereSalo
use onlySelf modifier instead
ad29f8a
@JereSalo
merge main
af1f5d7
@JereSalo
rename error in based contract
8a8df36
@JereSalo
require timelock address to be set if it's not based
a5c12c7
@JereSalo
make tiny changes
9e740c4
@JereSalo
deploy timelock only on non-based
f697e23
@JereSalo
improve comments in timelock contract
e4dd641
@JereSalo
add comments to Timelock contract
43589a8
@JereSalo
rename owner to governance
1e6c0b2
@JereSalo
Merge branch 'main' into timelock_l2
89bc0ba
@JereSalo
disable initialize function from TimelockControllerUpgradeable
1369951
@JereSalo
Merge branch 'timelock_l2' of github.com:lambdaclass/ethrex into time…
a16cd29 
…lock_l2
@JereSalo
Make Timelock inherit IOnChainProposer
7edc1e0
@JereSalo
let security council upgrade vks
f68872f
@JereSalo
add timelock docs (first draft)
aa731cf
@JereSalo JereSalo self-assigned this Dec 18, 2025
@JereSalo JereSalo changed the title add timelock docs (first draft) docs(l2): add timelock contract docs Dec 18, 2025
@github-actions github-actions bot added the L2 Rollup client label Dec 18, 2025
Base automatically changed from timelock_l2 to main January 5, 2026 20:50
@github-actions
Copy link

github-actions bot commented Jan 6, 2026

Lines of code report

Total lines added: 28
Total lines removed: 9
Total lines changed: 37

Detailed view 
+--------------------------------------------+-------+------+
| File                                       | Lines | Diff |
+--------------------------------------------+-------+------+
| ethrex/cmd/ethrex/build_l2.rs              | 447   | +5   |
+--------------------------------------------+-------+------+
| ethrex/cmd/ethrex/l2/command.rs            | 647   | +2   |
+--------------------------------------------+-------+------+
| ethrex/cmd/ethrex/l2/deployer.rs           | 1481  | -9   |
+--------------------------------------------+-------+------+
| ethrex/cmd/ethrex/l2/options.rs            | 1072  | +10  |
+--------------------------------------------+-------+------+
| ethrex/crates/l2/sequencer/configs.rs      | 107   | +1   |
+--------------------------------------------+-------+------+
| ethrex/crates/l2/sequencer/l1_committer.rs | 1384  | +10  |
+--------------------------------------------+-------+------+

@JereSalo JereSalo marked this pull request as ready for review January 6, 2026 14:50
@JereSalo JereSalo requested a review from a team as a code owner January 6, 2026 14:50
Copilot AI review requested due to automatic review settings January 6, 2026 14:50
Copilot AI reviewed Jan 6, 2026
View reviewed changes
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
ManuelBilbao approved these changes Jan 6, 2026
View reviewed changes
Copy link
Contributor

@ManuelBilbao ManuelBilbao left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a few nit comments

@tomip01 tomip01 enabled auto-merge January 7, 2026 13:49
@ManuelBilbao ManuelBilbao disabled auto-merge January 7, 2026 21:06
@ManuelBilbao ManuelBilbao added this pull request to the merge queue Jan 7, 2026
Merged via the queue into main with commit 55d9d50 Jan 7, 2026
40 checks passed
@ManuelBilbao ManuelBilbao deleted the add_timelock_docs branch January 7, 2026 21:39
@github-project-automation github-project-automation bot moved this to Done in ethrex_l2 Jan 7, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@ManuelBilbao ManuelBilbao ManuelBilbao approved these changes

@tomip01 tomip01 tomip01 approved these changes

Assignees

@JereSalo JereSalo

Labels

L2 Rollup client

Projects

ethrex_l2
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@JereSalo @ManuelBilbao @tomip01