TimelockGuard add basic configuration functionality #17401
Closed
Conversation
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
Contributor
Author
This stack of pull requests is managed by Graphite. Learn more about stacking. |
This was referenced Sep 9, 2025
maurelian
commented
Sep 9, 2025
Comment on lines
+19
to
+21
| struct GuardConfig { | ||
| uint256 timelockDelay; | ||
| } |
Contributor
Author
There was a problem hiding this comment.
Putting this single value into a struct is unnecessary, but claude did it (presumably following the example of ModuleConfig in LivenessModule2, and it felt kind of nice to namespace it so that you can use GuardConfig.timelockDelay.
I'm not opposed to getting rid of the struct though, open to opinions.
Contributor
There was a problem hiding this comment.
I think it is fine to keep it. I also like the namespace.
maurelian
commented
Sep 9, 2025
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## develop #17401 +/- ##
===========================================
- Coverage 95.92% 95.83% -0.09%
===========================================
Files 112 113 +1
Lines 5127 5162 +35
===========================================
+ Hits 4918 4947 +29
- Misses 209 215 +6
Flags with carried forward coverage won't be shown. Click here to find out more.
🚀 New features to boost your workflow:
|
maurelian
changed the title
alcueca
reviewed
Sep 10, 2025
alcueca
reviewed
Sep 10, 2025
alcueca
reviewed
Sep 10, 2025
maurelian
force-pushed
the
jm/timelock
branch
from
0b47817 to
bc7f865
Compare
- Add configureTimelockGuard function to allow Safes to set timelock delays - Validate timelock delay between 1 second and 1 year - Check that guard is properly enabled on calling Safe using getStorageAt() - Store configuration per Safe with GuardConfigured event emission - Add comprehensive test suite covering all spec requirements - Implement IGuard interface for Safe compatibility 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
- Add clearTimelockGuard function to allow Safes to clear timelock configuration - Validate that guard is disabled before allowing configuration clearing - Check that Safe was previously configured before clearing - Delete configuration data and emit GuardCleared event - Add comprehensive test suite covering all spec requirements - Add new errors: TimelockGuard_GuardNotConfigured, TimelockGuard_GuardStillEnabled 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
- Add internal _getGuard() helper to centralize guard address retrieval - Update configureTimelockGuard and clearTimelockGuard to use helper - Reduces code duplication and improves maintainability 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
- Add cancellationThreshold function to return current threshold for a Safe - Return 0 if guard not enabled or not configured - Initialize to 1 when Safe configures guard - Clear threshold when Safe clears guard configuration - Add comprehensive test suite covering all spec requirements - Function never reverts as per spec requirements 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
…lity - Add scheduleTransaction placeholder (Function 4) - Add checkPendingTransactions placeholder (Function 6) - Add rejectTransaction placeholder (Function 7) - Add rejectTransactionWithSignature placeholder (Function 8) - Add cancelTransaction placeholder (Function 9) - Update checkTransaction placeholder (Function 5) - All placeholders have proper signatures and documentation 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
maurelian
force-pushed
the
jm/timelock
branch
from
bc7f865 to
f085e72
Compare
Closed
![graphite-app[bot]](https://avatars.githubusercontent.com/in/158384?s=60&v=4){kind=small}
| /// @dev MUST return 0 if the contract is not enabled as a guard for the safe | ||
| /// @param _safe The Safe address to query | ||
| /// @return The current cancellation threshold | ||
| function cancellationThreshold(address _safe) public view returns (uint256) { |
Contributor
There was a problem hiding this comment.
The function return parameter lacks proper documentation. According to Solidity documentation standards, function return parameters should be documented with @return comments in NatSpec format. The return parameter should include a description explaining what the cancellationThreshold_ value represents.
Suggested change
| function cancellationThreshold(address _safe) public view returns (uint256) { | |
| /** | |
| * @notice Returns the cancellation threshold for a given safe | |
| * @param _safe The address of the safe | |
| * @return The number of confirmations required to cancel a transaction | |
| */ | |
| function cancellationThreshold(address _safe) public view returns (uint256) { |
Spotted by Diamond (based on custom rule: Custom rules)
Is this helpful? React 👍 or 👎 to let us know.
Contributor
Author
|
Replaced by #17465 |
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.
Description
This is the first PR in a forthcoming stack (expect 1 or 2 more PRs), which establishes the outline of the TimelockGuard contract.
It fully implements and tests the following functions of the TimelockGuard listed in the specs:
viewTimelockGuardConfigurationconfigureTimelockGuardclearTimelockGuardcancellationThresholdIt also includes empty placeholders for the following functions:
scheduleTransactioncheckTransactioncheckPendingTransactionsrejectTransactionrejectTransactionWithSignaturecancelTransactionThis PR does not combine the TimelockGuard and LivenessModule2, that is done in #17402.