Add new type of metadata renderer

ourzora · Jul 24, 2023 · 67d8f8e · 67d8f8e
1 parent 682d317
commit 67d8f8e
Show file tree

Hide file tree

Showing 23 changed files with 577 additions and 107 deletions.
diff --git a/script/DeployContracts.s.sol b/script/DeployContracts.s.sol
@@ -6,12 +6,11 @@ import { Strings } from "@openzeppelin/contracts/utils/Strings.sol";
 
 import { IManager, Manager } from "../src/manager/Manager.sol";
 import { IToken, Token } from "../src/token/Token.sol";
-import { MetadataRenderer } from "../src/token/metadata/MetadataRenderer.sol";
 import { IAuction, Auction } from "../src/auction/Auction.sol";
 import { IGovernor, Governor } from "../src/governance/governor/Governor.sol";
 import { ITreasury, Treasury } from "../src/governance/treasury/Treasury.sol";
-import { MetadataRenderer } from "../src/token/metadata/MetadataRenderer.sol";
-import { MetadataRendererTypesV1 } from "../src/token/metadata/types/MetadataRendererTypesV1.sol";
+import { PropertyMetadata } from "../src/metadata/property/PropertyMetadata.sol";
+import { PropertyMetadataTypesV1 } from "../src/metadata/property/types/PropertyMetadataTypesV1.sol";
 import { ERC1967Proxy } from "../src/lib/proxy/ERC1967Proxy.sol";
 
 contract DeployContracts is Script {
@@ -46,7 +45,7 @@ contract DeployContracts is Script {
         address tokenImpl = address(new Token(address(manager)));
 
         // Deploy metadata renderer implementation
-        address metadataRendererImpl = address(new MetadataRenderer(address(manager)));
+        address metadataRendererImpl = address(new PropertyMetadata(address(manager)));
 
         // Deploy auction house implementation
         address auctionImpl = address(new Auction(address(manager), weth));

diff --git a/script/DeployMetadataUpgrade.s.sol b/script/DeployMetadataUpgrade.s.sol
@@ -6,12 +6,11 @@ import { Strings } from "@openzeppelin/contracts/utils/Strings.sol";
 
 import { IManager, Manager } from "../src/manager/Manager.sol";
 import { IToken, Token } from "../src/token/Token.sol";
-import { MetadataRenderer } from "../src/token/metadata/MetadataRenderer.sol";
 import { IAuction, Auction } from "../src/auction/Auction.sol";
 import { IGovernor, Governor } from "../src/governance/governor/Governor.sol";
 import { ITreasury, Treasury } from "../src/governance/treasury/Treasury.sol";
-import { MetadataRenderer } from "../src/token/metadata/MetadataRenderer.sol";
-import { MetadataRendererTypesV1 } from "../src/token/metadata/types/MetadataRendererTypesV1.sol";
+import { PropertyMetadata } from "../src/metadata/property/PropertyMetadata.sol";
+import { PropertyMetadataTypesV1 } from "../src/metadata/property/types/PropertyMetadataTypesV1.sol";
 import { ERC1967Proxy } from "../src/lib/proxy/ERC1967Proxy.sol";
 
 contract DeployMetadataUpgrade is Script {
@@ -52,7 +51,7 @@ contract DeployMetadataUpgrade is Script {
         Manager manager = Manager(managerProxy);
 
         // Deploy metadata renderer implementation
-        address metadataRendererImpl = address(new MetadataRenderer(managerProxy));
+        address metadataRendererImpl = address(new PropertyMetadata(managerProxy));
 
         address managerImpl = address(new Manager());
 

diff --git a/script/DeployTokenUpgrade.s.sol b/script/DeployTokenUpgrade.s.sol
@@ -7,12 +7,11 @@ import { Strings } from "@openzeppelin/contracts/utils/Strings.sol";
 
 import { IManager, Manager } from "../src/manager/Manager.sol";
 import { IToken, Token } from "../src/token/Token.sol";
-import { MetadataRenderer } from "../src/token/metadata/MetadataRenderer.sol";
 import { IAuction, Auction } from "../src/auction/Auction.sol";
 import { IGovernor, Governor } from "../src/governance/governor/Governor.sol";
 import { ITreasury, Treasury } from "../src/governance/treasury/Treasury.sol";
-import { MetadataRenderer } from "../src/token/metadata/MetadataRenderer.sol";
-import { MetadataRendererTypesV1 } from "../src/token/metadata/types/MetadataRendererTypesV1.sol";
+import { PropertyMetadata } from "../src/metadata/property/PropertyMetadata.sol";
+import { PropertyMetadataTypesV1 } from "../src/metadata/property/types/PropertyMetadataTypesV1.sol";
 import { ERC1967Proxy } from "../src/lib/proxy/ERC1967Proxy.sol";
 
 contract DeployTokenUpgrade is Script {

diff --git a/script/DeployVersion1_1.s.sol b/script/DeployVersion1_1.s.sol
@@ -7,12 +7,11 @@ import { Strings } from "@openzeppelin/contracts/utils/Strings.sol";
 
 import { IManager, Manager } from "../src/manager/Manager.sol";
 import { IToken, Token } from "../src/token/Token.sol";
-import { MetadataRenderer } from "../src/token/metadata/MetadataRenderer.sol";
 import { IAuction, Auction } from "../src/auction/Auction.sol";
 import { IGovernor, Governor } from "../src/governance/governor/Governor.sol";
 import { ITreasury, Treasury } from "../src/governance/treasury/Treasury.sol";
-import { MetadataRenderer } from "../src/token/metadata/MetadataRenderer.sol";
-import { MetadataRendererTypesV1 } from "../src/token/metadata/types/MetadataRendererTypesV1.sol";
+import { PropertyMetadata } from "../src/metadata/property/PropertyMetadata.sol";
+import { PropertyMetadataTypesV1 } from "../src/metadata/property/types/PropertyMetadataTypesV1.sol";
 import { ERC1967Proxy } from "../src/lib/proxy/ERC1967Proxy.sol";
 
 contract DeployVersion1_1 is Script {
@@ -58,7 +57,7 @@ contract DeployVersion1_1 is Script {
         // Deploy token upgrade implementation
         address tokenUpgradeImpl = address(new Token(managerProxy));
         // Deploy metadata upgrade implementation
-        address metadataUpgradeImpl = address(new MetadataRenderer(managerProxy));
+        address metadataUpgradeImpl = address(new PropertyMetadata(managerProxy));
 
         address managerImpl = address(new Manager());
 

diff --git a/src/manager/IManager.sol b/src/manager/IManager.sol
@@ -40,6 +40,11 @@ interface IManager is IUUPS, IOwnable {
     /// @param upgradeImpl The upgrade implementation address
     event UpgradeRemoved(address baseImpl, address upgradeImpl);
 
+    /// @notice Event emitted when metadata renderer is updated.
+    /// @param sender address of the updater
+    /// @param renderer new metadata renderer address
+    event MetadataRendererUpdated(address sender, address renderer);
+
     ///                                                          ///
     ///                            ERRORS                        ///
     ///                                                          ///
@@ -56,6 +61,8 @@ interface IManager is IUUPS, IOwnable {
     /// @dev Reverts if an implementation type is not valid on registration
     error INVALID_IMPLEMENTATION_TYPE();
 
+    error ONLY_TOKEN_OWNER();
+
     ///                                                          ///
     ///                            STRUCTS                       ///
     ///                                                          ///

diff --git a/src/manager/Manager.sol b/src/manager/Manager.sol
@@ -9,10 +9,11 @@ import { ManagerStorageV1 } from "./storage/ManagerStorageV1.sol";
 import { ManagerStorageV2 } from "./storage/ManagerStorageV2.sol";
 import { IManager } from "./IManager.sol";
 import { IToken } from "../token/IToken.sol";
-import { IBaseMetadata } from "../token/metadata/interfaces/IBaseMetadata.sol";
+import { IBaseMetadata } from "../metadata/interfaces/IBaseMetadata.sol";
 import { IAuction } from "../auction/IAuction.sol";
 import { ITreasury } from "../governance/treasury/ITreasury.sol";
 import { IGovernor } from "../governance/governor/IGovernor.sol";
+import { IOwnable } from "../lib/interfaces/IOwnable.sol";
 
 import { VersionedContract } from "../VersionedContract.sol";
 import { IVersionedContract } from "../lib/interfaces/IVersionedContract.sol";
@@ -79,6 +80,7 @@ contract Manager is IManager, VersionedContract, UUPS, Ownable, ManagerStorageV1
         // Ensure all implementations are registered
         unchecked {
             for (uint256 i; i < implAddressesLength; ++i) {
+                if (i == IMPLEMENTATION_TYPE_METADATA) continue; // metadata registration is optional
                 if (!isImplementation[uint8(i)][_implAddresses[i]]) revert IMPLEMENTATION_NOT_REGISTERED();
             }
         }
@@ -113,6 +115,24 @@ contract Manager is IManager, VersionedContract, UUPS, Ownable, ManagerStorageV1
         emit DAODeployed({ token: token, metadata: metadata, auction: auction, treasury: treasury, governor: governor });
     }
 
+    /// @notice Set a new metadata renderer
+    /// @param _newRendererImpl new renderer address to use
+    /// @param _setupRenderer data to setup new renderer with
+    function setMetadataRenderer(address _token, address _newRendererImpl, bytes memory _setupRenderer) external {
+        if (msg.sender != IOwnable(_token).owner()) revert ONLY_TOKEN_OWNER();
+
+        address metadata = address(new ERC1967Proxy(_newRendererImpl, ""));
+        daoAddressesByToken[_token].metadata = metadata;
+
+        if (_setupRenderer.length > 0) {
+            IBaseMetadata(metadata).initialize(_setupRenderer, _token);
+        }
+
+        IToken(_token).setMetadataRenderer(IBaseMetadata(metadata));
+
+        emit MetadataRendererUpdated({ sender: msg.sender, renderer: metadata });
+    }
+
     ///                                                          ///
     ///                         DAO ADDRESSES                    ///
     ///                                                          ///

diff --git a/...ken/metadata/interfaces/IBaseMetadata.sol → src/metadata/interfaces/IBaseMetadata.sol b/...ken/metadata/interfaces/IBaseMetadata.sol → src/metadata/interfaces/IBaseMetadata.sol
@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: MIT
 pragma solidity 0.8.16;
 
-import { IUUPS } from "../../../lib/interfaces/IUUPS.sol";
+import { IUUPS } from "../../lib/interfaces/IUUPS.sol";
 
 /// @title IBaseMetadata
 /// @author Rohan Kulkarni