Add optional metadata URI to registry.add() (#263)

* Add optional metadata URI to registry.add()

* fix tests

* Maintain copy of TWRegistry and TWMultichainRegistry

* docs update

* Use TWMultichainRegistry in BaseTest

* add legacy TWRegistry ABI

* add docs

* Re-introduce original TWRegistry

Co-authored-by: Krishang Nadgauda <[email protected]>

Author: joaquim-verges

contracts/TWFactory.sol

@@ -75,7 +75,7 @@ contract TWFactory is Multicall, ERC2771Context, AccessControlEnumerable, IContr
 
         emit ProxyDeployed(_implementation, deployedProxy, _msgSender());
 
-        registry.add(_msgSender(), deployedProxy, block.chainid);
+        registry.add(_msgSender(), deployedProxy);
 
         if (_data.length > 0) {
             // slither-disable-next-line unused-return

contracts/TWMultichainRegistry.sol

@@ -0,0 +1,110 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.11;
+
+import "@openzeppelin/contracts/utils/structs/EnumerableSet.sol";
+import "@openzeppelin/contracts/access/AccessControlEnumerable.sol";
+import "@openzeppelin/contracts/utils/Multicall.sol";
+import "@openzeppelin/contracts/metatx/ERC2771Context.sol";
+
+import "./interfaces/ITWMultichainRegistry.sol";
+
+contract TWMultichainRegistry is ITWMultichainRegistry, Multicall, ERC2771Context, AccessControlEnumerable {
+    bytes32 public constant OPERATOR_ROLE = keccak256("OPERATOR_ROLE");
+
+    using EnumerableSet for EnumerableSet.AddressSet;
+    using EnumerableSet for EnumerableSet.UintSet;
+
+    /// @dev wallet address => [contract addresses]
+    mapping(address => mapping(uint256 => EnumerableSet.AddressSet)) private deployments;
+    /// @dev contract address deployed => imported metadata uri
+    mapping(uint256 => mapping(address => string)) private addressToMetadataUri;
+
+    EnumerableSet.UintSet private chainIds;
+
+    constructor(address _trustedForwarder) ERC2771Context(_trustedForwarder) {
+        _setupRole(DEFAULT_ADMIN_ROLE, _msgSender());
+    }
+
+    // slither-disable-next-line similar-names
+    function add(
+        address _deployer,
+        address _deployment,
+        uint256 _chainId,
+        string memory metadataUri
+    ) external {
+        require(hasRole(OPERATOR_ROLE, _msgSender()) || _deployer == _msgSender(), "not operator or deployer.");
+
+        bool added = deployments[_deployer][_chainId].add(_deployment);
+        require(added, "failed to add");
+
+        chainIds.add(_chainId);
+
+        if (bytes(metadataUri).length > 0) {
+            addressToMetadataUri[_chainId][_deployment] = metadataUri;
+        }
+
+        emit Added(_deployer, _deployment, _chainId, metadataUri);
+    }
+
+    // slither-disable-next-line similar-names
+    function remove(
+        address _deployer,
+        address _deployment,
+        uint256 _chainId
+    ) external {
+        require(hasRole(OPERATOR_ROLE, _msgSender()) || _deployer == _msgSender(), "not operator or deployer.");
+
+        bool removed = deployments[_deployer][_chainId].remove(_deployment);
+        require(removed, "failed to remove");
+
+        emit Deleted(_deployer, _deployment, _chainId);
+    }
+
+    function getAll(address _deployer) external view returns (Deployment[] memory allDeployments) {
+        uint256 totalDeployments;
+        uint256 chainIdsLen = chainIds.length();
+
+        for (uint256 i = 0; i < chainIdsLen; i += 1) {
+            uint256 chainId = chainIds.at(i);
+
+            totalDeployments += deployments[_deployer][chainId].length();
+        }
+
+        allDeployments = new Deployment[](totalDeployments);
+        uint256 idx;
+
+        for (uint256 j = 0; j < chainIdsLen; j += 1) {
+            uint256 chainId = chainIds.at(j);
+
+            uint256 len = deployments[_deployer][chainId].length();
+            address[] memory deploymentAddrs = deployments[_deployer][chainId].values();
+
+            for (uint256 k = 0; k < len; k += 1) {
+                allDeployments[idx] = Deployment({ deploymentAddress: deploymentAddrs[k], chainId: chainId });
+                idx += 1;
+            }
+        }
+    }
+
+    function count(address _deployer) external view returns (uint256 deploymentCount) {
+        uint256 chainIdsLen = chainIds.length();
+
+        for (uint256 i = 0; i < chainIdsLen; i += 1) {
+            uint256 chainId = chainIds.at(i);
+
+            deploymentCount += deployments[_deployer][chainId].length();
+        }
+    }
+
+    function getMetadataUri(uint256 _chainId, address _deployment) external view returns (string memory metadataUri) {
+        metadataUri = addressToMetadataUri[_chainId][_deployment];
+    }
+
+    function _msgSender() internal view virtual override(Context, ERC2771Context) returns (address sender) {
+        return ERC2771Context._msgSender();
+    }
+
+    function _msgData() internal view virtual override(Context, ERC2771Context) returns (bytes calldata) {
+        return ERC2771Context._msgData();
+    }
+}

contracts/TWRegistry.sol

@@ -6,87 +6,47 @@ import "@openzeppelin/contracts/access/AccessControlEnumerable.sol";
 import "@openzeppelin/contracts/utils/Multicall.sol";
 import "@openzeppelin/contracts/metatx/ERC2771Context.sol";
 
-import "./interfaces/ITWRegistry.sol";
-
-contract TWRegistry is ITWRegistry, Multicall, ERC2771Context, AccessControlEnumerable {
+contract TWRegistry is Multicall, ERC2771Context, AccessControlEnumerable {
     bytes32 public constant OPERATOR_ROLE = keccak256("OPERATOR_ROLE");
 
     using EnumerableSet for EnumerableSet.AddressSet;
-    using EnumerableSet for EnumerableSet.UintSet;
 
     /// @dev wallet address => [contract addresses]
-    mapping(address => mapping(uint256 => EnumerableSet.AddressSet)) private deployments;
+    mapping(address => EnumerableSet.AddressSet) private deployments;
 
-    EnumerableSet.UintSet private chainIds;
+    event Added(address indexed deployer, address indexed deployment);
+    event Deleted(address indexed deployer, address indexed deployment);
 
     constructor(address _trustedForwarder) ERC2771Context(_trustedForwarder) {
         _setupRole(DEFAULT_ADMIN_ROLE, _msgSender());
     }
 
     // slither-disable-next-line similar-names
-    function add(
-        address _deployer,
-        address _deployment,
-        uint256 _chainId
-    ) external {
+    function add(address _deployer, address _deployment) external {
         require(hasRole(OPERATOR_ROLE, _msgSender()) || _deployer == _msgSender(), "not operator or deployer.");
 
-        bool added = deployments[_deployer][_chainId].add(_deployment);
+        bool added = deployments[_deployer].add(_deployment);
         require(added, "failed to add");
 
-        chainIds.add(_chainId);
-
-        emit Added(_deployer, _deployment, _chainId);
+        emit Added(_deployer, _deployment);
     }
 
     // slither-disable-next-line similar-names
-    function remove(
-        address _deployer,
-        address _deployment,
-        uint256 _chainId
-    ) external {
+    function remove(address _deployer, address _deployment) external {
         require(hasRole(OPERATOR_ROLE, _msgSender()) || _deployer == _msgSender(), "not operator or deployer.");
 
-        bool removed = deployments[_deployer][_chainId].remove(_deployment);
+        bool removed = deployments[_deployer].remove(_deployment);
         require(removed, "failed to remove");
 
-        emit Deleted(_deployer, _deployment, _chainId);
+        emit Deleted(_deployer, _deployment);
     }
 
-    function getAll(address _deployer) external view returns (Deployment[] memory allDeployments) {
-        uint256 totalDeployments;
-        uint256 chainIdsLen = chainIds.length();
-
-        for (uint256 i = 0; i < chainIdsLen; i += 1) {
-            uint256 chainId = chainIds.at(i);
-
-            totalDeployments += deployments[_deployer][chainId].length();
-        }
-
-        allDeployments = new Deployment[](totalDeployments);
-        uint256 idx;
-
-        for (uint256 j = 0; j < chainIdsLen; j += 1) {
-            uint256 chainId = chainIds.at(j);
-
-            uint256 len = deployments[_deployer][chainId].length();
-            address[] memory deploymentAddrs = deployments[_deployer][chainId].values();
-
-            for (uint256 k = 0; k < len; k += 1) {
-                allDeployments[idx] = Deployment({ deploymentAddress: deploymentAddrs[k], chainId: chainId });
-                idx += 1;
-            }
-        }
+    function getAll(address _deployer) external view returns (address[] memory) {
+        return deployments[_deployer].values();
     }
 
-    function count(address _deployer) external view returns (uint256 deploymentCount) {
-        uint256 chainIdsLen = chainIds.length();
-
-        for (uint256 i = 0; i < chainIdsLen; i += 1) {
-            uint256 chainId = chainIds.at(i);
-
-            deploymentCount += deployments[_deployer][chainId].length();
-        }
+    function count(address _deployer) external view returns (uint256) {
+        return deployments[_deployer].length();
     }
 
     function _msgSender() internal view virtual override(Context, ERC2771Context) returns (address sender) {

contracts/interfaces/IContractMetadataRegistry.sol

@@ -0,0 +1,36 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.11;
+
+interface ITWMultichainRegistry {
+    struct Deployment {
+        address deploymentAddress;
+        uint256 chainId;
+    }
+
+    event Added(address indexed deployer, address indexed deployment, uint256 indexed chainId, string metadataUri);
+    event Deleted(address indexed deployer, address indexed deployment, uint256 indexed chainId);
+
+    /// @notice Add a deployment for a deployer.
+    function add(
+        address _deployer,
+        address _deployment,
+        uint256 _chainId,
+        string memory metadataUri
+    ) external;
+
+    /// @notice Remove a deployment for a deployer.
+    function remove(
+        address _deployer,
+        address _deployment,
+        uint256 _chainId
+    ) external;
+
+    /// @notice Get all deployments for a deployer.
+    function getAll(address _deployer) external view returns (Deployment[] memory allDeployments);
+
+    /// @notice Get the total number of deployments for a deployer.
+    function count(address _deployer) external view returns (uint256 deploymentCount);
+
+    /// @notice Returns the metadata IPFS URI for a deployment on a given chain if previously registered via add().
+    function getMetadataUri(uint256 _chainId, address _deployment) external view returns (string memory metadataUri);
+}