Skip to content
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.

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

Relax OpenZeppelin upgrades plugin validation checks #684

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

cam-schultz
Copy link
Contributor

Why this should be merged

Fixes #648 by allowing constructors and external library calls.

How this works

Adds NatSpec comments to the upgradeable validator-manager contracts to bypass the constructor and external-library-linking validation rules.

How this was tested

Ci

How is this documented

N/A

Copy link
Contributor

@iansuvak iansuvak left a comment

Choose a reason for hiding this comment

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

The change LGTM but did we confirm it actually accomplishes the goal?

@cam-schultz
Copy link
Contributor Author

The change LGTM but did we confirm it actually accomplishes the goal?

I haven't directly. I'm hitting some confusing errors when running a forge script that calls the upgrades plugin. The NatSpec comments should apply to the entire contract , however.

That said, I'd also be fine leaving it to users to pass the relaxation flags to the plugin themselves. In which case, we would just want to document the process and leave the source code alone.

@cam-schultz cam-schultz marked this pull request as draft December 12, 2024 20:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: In Review 👀
Development

Successfully merging this pull request may close these issues.

Make ValidatorManager contracts compatible with OpenZeppelin upgrades plugins
4 participants