Update manager to support multiple implementation contracts #105

neokry · 2023-07-18T07:01:46Z

Updates manager for upcoming V2 changes

manager now allows Builder DAO to register alternate implementations
Auction, Governor, Token, Treasury and Metadata contracts now take bytes data as initialization data to keep manager generic

Code Review

should we keep address parameters the same for core contracts or pass in something more generic ie a struct with all address a contract could need in an initialization step? (is this worth an increase in calldata?)
should the manager type system use an enum instead of public const uint8s?

iainnash · 2023-08-04T11:42:39Z

src/auction/Auction.sol

-        uint256 _reservePrice
-    ) external initializer {
+    /// @param _data The encoded auction settings
+    function initialize(address _token, address _founder, address _treasury, bytes calldata _data) external initializer {


typically i prefer structs in this situation as noted in the diff notes due to sometimes lower code size and easier initialization on the front-end.

The _data parameter is a struct so clients will be using a struct to encode it still. the address params come from the manager contract. would a struct still be useful for the code size aspect?

iainnash · 2023-08-04T11:43:28Z

src/auction/Auction.sol

@@ -82,9 +75,11 @@ contract Auction is IAuction, VersionedContract, UUPS, Ownable, ReentrancyGuard,
        // Store DAO's ERC-721 token
        token = Token(_token);

+        AuctionParams memory params = abi.decode(_data, (AuctionParams));


This also could be an inner struct – depends on how much you want to change things.

same comments as the other one mentioning structs @iainnash:

To create a struct with the addresses and data parameters we would need to copy the _data param (from calldata) and deployed addresses (from storage) to memory which might be more expensive than re-encodinga and passing the calldata I think

what are your thoughts on this?

iainnash · 2023-08-04T11:44:01Z

src/governance/governor/Governor.sol

-        uint256 _quorumThresholdBps
-    ) external initializer {
+    /// @param _data The encoded governor parameters
+    function initialize(address _treasury, address _token, bytes calldata _data) external initializer {


could pass in the generic struct here and _data as a part of that to prevent re-encoding and passing the calldata so many times.

To create a struct with the addresses and data parameters we would need to copy the _data param (from calldata) and deployed addresses (from storage) to memory which might be more expensive than re-encodinga and passing the calldata I think

iainnash

I want to take more time reviewing this but this is a first pass – would be helpful to not have all the linter changes here (But I think I have a tool to remove them) since this is a fairly large diff.

I'll think about a better way than the tagged array but that approach makes sense – more sense than nulling out a struct. another approach is a struct with an ID in it but that requires more iteration.

src/governance/governor/Governor.sol

iainnash · 2023-08-04T11:46:04Z

src/manager/Manager.sol

-        governorImpl = _governorImpl;
-    }
+    // Public constants for implementation types.
+    // Allows for adding new types later easily compared to a enum.


i believe at this point enums under the hood are uint8 – this just makes it more clear when you add items.

iainnash · 2023-08-04T11:47:27Z

src/manager/Manager.sol

-        auction = address(new ERC1967Proxy{ salt: salt }(auctionImpl, ""));
-        treasury = address(new ERC1967Proxy{ salt: salt }(treasuryImpl, ""));
-        governor = address(new ERC1967Proxy{ salt: salt }(governorImpl, ""));
+        metadata = address(new ERC1967Proxy{ salt: salt }(_implAddresses[IMPLEMENTATION_TYPE_METADATA], ""));


salt isn't really needed but i don't think it hurts this – since our impl addresses now can change

src/manager/Manager.sol

neokry · 2023-08-07T02:56:36Z

I want to take more time reviewing this but this is a first pass – would be helpful to not have all the linter changes here (But I think I have a tool to remove them) since this is a fairly large diff.

I'll think about a better way than the tagged array but that approach makes sense – more sense than nulling out a struct. another approach is a struct with an ID in it but that requires more iteration.

forgot to fix the linter changes. updated now to match the original formatting

jgeary · 2023-08-16T16:01:42Z

@neokry havent dug deep into this yet but please run the storage generate script so isImplementation is included in the storage layout.

iainnash · 2023-08-23T14:11:05Z

src/manager/Manager.sol

+        uint256 implAddressesLength = _implAddresses.length;
+
+        // Ensure implementation parameters are correct length
+        if (implAddressesLength != IMPLEMENTATION_TYPE_COUNT || _implData.length != IMPLEMENTATION_TYPE_COUNT) revert INVALID_IMPLEMENTATION_PARAMS();


nit: { and } brackets.

neokry added 2 commits July 18, 2023 14:51

Update manager to support multiple implementation contracts

a7f3cc5

Add validation to implementation addresses

6dce92e

neokry temporarily deployed to Test July 19, 2023 00:59 — with GitHub Actions Inactive

Adds new manager tests

682d317

neokry temporarily deployed to Test July 19, 2023 05:18 — with GitHub Actions Inactive

neokry requested a review from iainnash July 31, 2023 06:48

iainnash reviewed Aug 4, 2023

View reviewed changes

Fix typo

1b2bad0

neokry temporarily deployed to Test August 7, 2023 02:31 — with GitHub Actions Inactive

Fix if statement formatting and impl type comment

921c5f2

neokry temporarily deployed to Test August 7, 2023 02:43 — with GitHub Actions Inactive

Fix formatting

ff754ea

neokry temporarily deployed to Test August 7, 2023 02:54 — with GitHub Actions Inactive

Update storage layout

f3841bb

neokry temporarily deployed to Test August 17, 2023 03:53 — with GitHub Actions Inactive

iainnash reviewed Aug 23, 2023

View reviewed changes

neokry closed this Oct 20, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update manager to support multiple implementation contracts #105

Update manager to support multiple implementation contracts #105

neokry commented Jul 18, 2023 •

edited

Loading

iainnash Aug 4, 2023

neokry Aug 7, 2023

iainnash Aug 4, 2023

iainnash Aug 23, 2023

neokry Aug 24, 2023

iainnash Aug 4, 2023

neokry Aug 7, 2023

iainnash left a comment

iainnash Aug 4, 2023

iainnash Aug 4, 2023

neokry commented Aug 7, 2023

jgeary commented Aug 16, 2023

iainnash Aug 23, 2023

Update manager to support multiple implementation contracts #105

Update manager to support multiple implementation contracts #105

Conversation

neokry commented Jul 18, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

iainnash left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

neokry commented Aug 7, 2023

jgeary commented Aug 16, 2023

Choose a reason for hiding this comment

neokry commented Jul 18, 2023 •

edited

Loading