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.

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

Implement UUPS proxy (ERC1822) #2542

Merged
merged 55 commits into from Apr 16, 2021
Merged

Implement UUPS proxy (ERC1822) #2542

merged 55 commits into from Apr 16, 2021

Conversation

Amxx
Copy link
Collaborator

@Amxx Amxx commented Feb 26, 2021 •
edited

Fixes #2421

Renames UpgradeableProxy into UUPSProxy, with the proxy only containing the initializing constructor and the _implementation() function. UUPS slot related tools are in a UUPS abstract contract, used by both the UUPSProxy and the UUPSProxiable contracts.

Contract that used to inherit from UpgradeableProxy now inherit from UUPSProxy, with no further changes needed.

PR Checklist

  • Tests
  • Documentation
  • Changelog entry

@Amxx Amxx force-pushed the feature/UUPS branch 2 times, most recently from efdd64a to 73b18f7 Compare February 26, 2021 12:50
@Amxx Amxx changed the title Feature/uups Refactor the proxy around UUPS (ERC1822) proxy Feb 26, 2021
@Amxx Amxx force-pushed the feature/UUPS branch 3 times, most recently from 1e133ae to c531138 Compare March 9, 2021 14:11
Amxx added 22 commits March 23, 2021 16:28
@Amxx
add uups implementation
9a8457e
@Amxx
fix UUPSProxy and add tests
069baf0
@Amxx
refactor uups: proxy upgradeable is now uupsproxy
ea41a20
@Amxx
fix error message prefix
9108acd
@Amxx
moving utils for implementation AND admin slots to ERC1967Utils + Tra…
52fbb1e 
…nsparent proxy refactor
@Amxx
rename Proxiable → ERC1967Upgrade
9777045
@Amxx
used beforeUpgrade ifAdmin in transparentUpgradeableProxy
de80b2d
@Amxx
refactor ERC1967Utils using the a StorageSlot library
13c4568
@Amxx
Expand ERC1967Utils to support implementation, admin and beacon slots
130f7ed
@Amxx
test & evaluate gas cost of secure upgrades
b2b3b2a
@Amxx
more tests for ERC1967upgrade
41a2057
@Amxx
refactor ERC1967Upgrade with an added secure variant
afb7af7
@Amxx
hardcode upgradePending
cf8e25d
@Amxx
remove unwanted event when upgrading
29fc4cc
@Amxx
refactor
3a07fe0
@Amxx
refactor proxy upgrades again
2253d85
@Amxx
fix rebasing issues
b204b3c
@Amxx
add contract/proxy/simple
10faeac
@Amxx
moving files accross
1b7e21e
@Amxx
fix documentation and migration script
3a28a38
@Amxx
add storage slot testing
43172c6
@Amxx
improve uups testing
482d344
Amxx and others added 22 commits April 13, 2021 18:09
@Amxx
use new syntax for the custom natspec
9d9ba5c
@Amxx @frangio
Apply suggestions from code review
666392a 
Co-authored-by: Francisco Giordano <frangio.1@gmail.com>
@Amxx
Change secure update mechanism and address comments from review
5d3d91f
@Amxx
add a test: using a proxy as an implementation must revert
f5c7c39
@Amxx
re-enable rollback-based upgrade protection
36274b0
@Amxx
Merge remote-tracking branch 'upstream/master' into feature/UUPS
49fb747
@Amxx
document storageslot.sol
d8c6aa9
@Amxx
document sotrage slot
56977b4
@frangio
remove hardhat/console.sol import
58b9bfd
@frangio
fix typos and tweak wording
9a52dfb
@frangio
add docs for each function in StorageSlot
7c77eda
@frangio
fix heading level
6613128
@frangio
rename _beforeUpgrade in docs and fix typo
00beb23
@frangio
add BeaconProxy._setBeacon for backwards compat
f31c862
@frangio
use name of return variable
5f54669
@frangio
rename test variables
3fb6c00
@frangio
remove commented lines
6ffa861
@frangio
remove unnecessary describe block
3a39dee
@frangio
rename proxiable -> upgradeable
18ee863
@frangio
clarify test description
446f803
@frangio
make state variable private
d763982
@frangio
improve docs in ERC1967Upgrade
6780f1e
@frangio frangio marked this pull request as ready for review April 16, 2021 03:12
frangio
frangio reviewed Apr 16, 2021
View reviewed changes
Copy link
Contributor

@frangio frangio left a comment

Choose a reason for hiding this comment

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

Two things before merging:

  1. Removing the _upgradeToAndCall* overloads, keeping only the version with the forceCall argument.
  2. Adding a test that an upgrade to a non-UUPSUpgradeable contract reverts.

frangio
frangio approved these changes Apr 16, 2021
View reviewed changes
Copy link
Contributor

@frangio frangio left a comment

Choose a reason for hiding this comment

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

LGTM. Thank you.

@frangio frangio merged commit 1c676ac into OpenZeppelin:master Apr 16, 2021
@Amxx Amxx deleted the feature/UUPS branch April 16, 2021 14:51
@HAOYUatHZ HAOYUatHZ mentioned this pull request May 7, 2021
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@frangio frangio frangio approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Provide implementation of UUPS proxy pattern
2 participants
@Amxx @frangio