Add access control to Pausable trait examples#1764
Merged
leighmcculloch merged 12 commits intomainfrom Mar 17, 2026
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the v25 migration note for #[contracttrait] to demonstrate a more realistic “pausable” pattern that includes admin authorization, constructor initialization, and test setup using testutils mock auths.
Changes:
- Introduces an auxiliary (non-exported)
RequireAuthForPausetrait and makesPausabledepend on it. - Adds an
__constructorto initialize anadminvalue in instance storage and enforcesrequire_auth()inpause/unpause. - Expands the doctest examples to show
MockAuth/MockAuthInvokeusage for authorized calls.
mootz12
approved these changes
Mar 17, 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.
What
pause()andunpause()default implementations in the v25contracttraitmigration guide now callrequire_authon an admin address retrieved from instance storage. A__constructoris added to each example to initialize the admin address. Inline string literals for storage keys are replaced with named constantsADMINandPAUSED.Why
The previous examples exported
pause()andunpause()as publicly callable contract functions without any authorization check. Developers following the pattern as written would ship contracts with open pause entrypoints. This ensures the examples start from a secure baseline. Closes #1763.Close #1763