Add IContractFactory interface (#219)

Author: joaquim-verges

contracts/TWFactory.sol

@@ -3,14 +3,15 @@ pragma solidity ^0.8.11;
 
 import "./TWRegistry.sol";
 import "./interfaces/IThirdwebContract.sol";
+import "./extension/interface/IContractFactory.sol";
 
 import "@openzeppelin/contracts/access/AccessControlEnumerable.sol";
 import "@openzeppelin/contracts/metatx/ERC2771Context.sol";
 import "@openzeppelin/contracts/utils/Create2.sol";
 import "@openzeppelin/contracts/utils/Multicall.sol";
 import "@openzeppelin/contracts/proxy/Clones.sol";
 
-contract TWFactory is Multicall, ERC2771Context, AccessControlEnumerable {
+contract TWFactory is Multicall, ERC2771Context, AccessControlEnumerable, IContractFactory {
     /// @dev Only FACTORY_ROLE holders can approve/unapprove implementations for proxies to point to.
     bytes32 public constant FACTORY_ROLE = keccak256("FACTORY_ROLE");
 
@@ -64,7 +65,7 @@ contract TWFactory is Multicall, ERC2771Context, AccessControlEnumerable {
         address _implementation,
         bytes memory _data,
         bytes32 _salt
-    ) public returns (address deployedProxy) {
+    ) public override returns (address deployedProxy) {
         require(approval[_implementation], "implementation not approved");
 
         bytes32 salthash = keccak256(abi.encodePacked(_msgSender(), _salt));

contracts/extension/interface/IContractFactory.sol

@@ -0,0 +1,18 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.0;
+
+interface IContractFactory {
+    /**
+     *  @notice Deploys a proxy that points to that points to the given implementation.
+     *
+     *  @param implementation           Address of the implementation to point to.
+     *
+     *  @param data                     Additional data to pass to the proxy constructor or any other data useful during deployement.
+     *  @param salt                     Salt to use for the deterministic address generation.
+     */
+    function deployProxyByImplementation(
+        address implementation,
+        bytes memory data,
+        bytes32 salt
+    ) external returns (address);
+}

docs/IContractFactory.md

@@ -0,0 +1,39 @@
+# IContractFactory
+
+
+
+
+
+
+
+
+
+## Methods
+
+### deployProxyByImplementation
+
+```solidity
+function deployProxyByImplementation(address implementation, bytes data, bytes32 salt) external nonpayable returns (address)
+```
+
+Deploys a proxy that points to that points to the given implementation.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| implementation | address | Address of the implementation to point to.
+| data | bytes | Additional data to pass to the proxy constructor or any other data useful during deployement.
+| salt | bytes32 | Salt to use for the deterministic address generation.
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | address | undefined
+
+
+
+