Minimal factory (#288)

* draft generic factory

* TWMinimalFactory

* add test, script

* v3.2.8-1

* salt-hash in minimal factory

* generic stateless factory

* forge update

* add thirdweb attribution

---------

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

Author: kumaryash90

contracts/TWMinimalFactory.sol

@@ -0,0 +1,51 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.11;
+
+/// @author thirdweb
+
+//   $$\     $$\       $$\                 $$\                         $$\
+//   $$ |    $$ |      \__|                $$ |                        $$ |
+// $$$$$$\   $$$$$$$\  $$\  $$$$$$\   $$$$$$$ |$$\  $$\  $$\  $$$$$$\  $$$$$$$\
+// \_$$  _|  $$  __$$\ $$ |$$  __$$\ $$  __$$ |$$ | $$ | $$ |$$  __$$\ $$  __$$\
+//   $$ |    $$ |  $$ |$$ |$$ |  \__|$$ /  $$ |$$ | $$ | $$ |$$$$$$$$ |$$ |  $$ |
+//   $$ |$$\ $$ |  $$ |$$ |$$ |      $$ |  $$ |$$ | $$ | $$ |$$   ____|$$ |  $$ |
+//   \$$$$  |$$ |  $$ |$$ |$$ |      \$$$$$$$ |\$$$$$\$$$$  |\$$$$$$$\ $$$$$$$  |
+//    \____/ \__|  \__|\__|\__|       \_______| \_____\____/  \_______|\_______/
+
+import "@openzeppelin/contracts/utils/Address.sol";
+import "@openzeppelin/contracts/proxy/Clones.sol";
+
+contract TWMinimalFactory {
+    /// @dev Deploys a proxy that points to the given implementation.
+    constructor(
+        address _implementation,
+        bytes memory _data,
+        bytes32 _salt
+    ) payable {
+        address instance;
+        bytes32 salthash = keccak256(abi.encodePacked(msg.sender, _salt));
+        assembly {
+            let ptr := mload(0x40)
+            mstore(ptr, 0x3d602d80600a3d3981f3363d3d373d3d3d363d73000000000000000000000000)
+            mstore(add(ptr, 0x14), shl(0x60, _implementation))
+            mstore(add(ptr, 0x28), 0x5af43d82803e903d91602b57fd5bf30000000000000000000000000000000000)
+            instance := create2(0, ptr, 0x37, salthash)
+        }
+
+        if (_data.length > 0) {
+            // instance.call{ value: msg.value }(_data);
+
+            // solhint-disable-next-line avoid-low-level-calls
+            (bool success, bytes memory result) = instance.call{ value: msg.value }(_data);
+
+            if (!success) {
+                // Next 5 lines from https://ethereum.stackexchange.com/a/83577
+                if (result.length < 68) revert("Transaction reverted silently");
+                assembly {
+                    result := add(result, 0x04)
+                }
+                revert(abi.decode(result, (string)));
+            }
+        }
+    }
+}

contracts/TWStatelessFactory.sol

@@ -0,0 +1,51 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.11;
+
+/// @author thirdweb
+
+//   $$\     $$\       $$\                 $$\                         $$\
+//   $$ |    $$ |      \__|                $$ |                        $$ |
+// $$$$$$\   $$$$$$$\  $$\  $$$$$$\   $$$$$$$ |$$\  $$\  $$\  $$$$$$\  $$$$$$$\
+// \_$$  _|  $$  __$$\ $$ |$$  __$$\ $$  __$$ |$$ | $$ | $$ |$$  __$$\ $$  __$$\
+//   $$ |    $$ |  $$ |$$ |$$ |  \__|$$ /  $$ |$$ | $$ | $$ |$$$$$$$$ |$$ |  $$ |
+//   $$ |$$\ $$ |  $$ |$$ |$$ |      $$ |  $$ |$$ | $$ | $$ |$$   ____|$$ |  $$ |
+//   \$$$$  |$$ |  $$ |$$ |$$ |      \$$$$$$$ |\$$$$$\$$$$  |\$$$$$$$\ $$$$$$$  |
+//    \____/ \__|  \__|\__|\__|       \_______| \_____\____/  \_______|\_______/
+
+import "./extension/interface/IContractFactory.sol";
+
+import "@openzeppelin/contracts/metatx/ERC2771Context.sol";
+import "@openzeppelin/contracts/utils/Multicall.sol";
+import "@openzeppelin/contracts/proxy/Clones.sol";
+
+contract TWStatelessFactory is Multicall, ERC2771Context, IContractFactory {
+    /// @dev Emitted when a proxy is deployed.
+    event ProxyDeployed(address indexed implementation, address proxy, address indexed deployer);
+
+    constructor(address _trustedForwarder) ERC2771Context(_trustedForwarder) {}
+
+    /// @dev Deploys a proxy that points to the given implementation.
+    function deployProxyByImplementation(
+        address _implementation,
+        bytes memory _data,
+        bytes32 _salt
+    ) public override returns (address deployedProxy) {
+        bytes32 salthash = keccak256(abi.encodePacked(_msgSender(), _salt));
+        deployedProxy = Clones.cloneDeterministic(_implementation, salthash);
+
+        emit ProxyDeployed(_implementation, deployedProxy, _msgSender());
+
+        if (_data.length > 0) {
+            // slither-disable-next-line unused-return
+            Address.functionCall(deployedProxy, _data);
+        }
+    }
+
+    function _msgSender() internal view virtual override returns (address sender) {
+        return ERC2771Context._msgSender();
+    }
+
+    function _msgData() internal view virtual override returns (bytes calldata) {
+        return ERC2771Context._msgData();
+    }
+}

docs/TWMinimalFactory.md

@@ -0,0 +1,12 @@
+# TWMinimalFactory
+
+
+
+
+
+
+
+
+
+
+

lib/ds-test

@@ -0,0 +1,92 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.0;
+
+import "contracts/TWMinimalFactory.sol";
+import "contracts/TWProxy.sol";
+
+import "@openzeppelin/contracts/proxy/Clones.sol";
+import "@openzeppelin/contracts/utils/Strings.sol";
+
+import "../utils/BaseTest.sol";
+
+contract DummyUpgradeable {
+    uint256 public number;
+
+    constructor() {}
+
+    function initialize(uint256 _num) public {
+        number = _num;
+    }
+}
+
+contract TWNotMinimalFactory {
+    /// @dev Deploys a proxy that points to the given implementation.
+    function deployProxyByImplementation(
+        address _implementation,
+        bytes memory _data,
+        bytes32 _salt
+    ) public {
+        address deployedProxy = Clones.cloneDeterministic(_implementation, _salt);
+
+        if (_data.length > 0) {
+            // slither-disable-next-line unused-return
+            Address.functionCall(deployedProxy, _data);
+        }
+    }
+}
+
+contract MinimalFactoryTest is BaseTest {
+    address internal implementation;
+    bytes32 internal salt;
+    bytes internal data;
+    address admin;
+
+    TWNotMinimalFactory notMinimal;
+
+    function setUp() public override {
+        super.setUp();
+        admin = getActor(5000);
+        vm.startPrank(admin);
+        implementation = getContract("TokenERC20");
+        salt = keccak256("yooo");
+        data = abi.encodeWithSelector(
+            TokenERC20.initialize.selector,
+            admin,
+            "MinimalToken",
+            "MT",
+            "ipfs://notCentralized",
+            new address[](0),
+            admin,
+            admin,
+            50
+        );
+
+        notMinimal = new TWNotMinimalFactory();
+    }
+
+    // gas: Baseline + 140k
+    function test_gas_twProxy() public {
+        new TWProxy(implementation, data);
+    }
+
+    // gas: Baseline + 41.5k
+    function test_gas_notMinimalFactory() public {
+        notMinimal.deployProxyByImplementation(implementation, data, salt);
+    }
+
+    // gas: Baseline
+    function test_gas_minimal() public {
+        new TWMinimalFactory(implementation, data, salt);
+    }
+
+    function test_verify_deployedProxy() public {
+        vm.stopPrank();
+        vm.prank(address(0x123456));
+        address minimalFactory = address(new TWMinimalFactory(implementation, data, salt));
+        bytes32 salthash = keccak256(abi.encodePacked(address(0x123456), salt));
+        address deployedProxy = Clones.predictDeterministicAddress(implementation, salthash, minimalFactory);
+
+        bytes32 contractType = TokenERC20(deployedProxy).contractType();
+        assertEq(contractType, bytes32("TokenERC20"));
+    }
+}

lib/forge-std

@@ -0,0 +1,22 @@
+const { MerkleTree } = require("merkletreejs");
+const keccak256 = require("keccak256");
+const { ethers } = require("ethers");
+
+const process = require("process");
+
+let implementationAddress = process.argv[2];
+let signer = process.argv[3];
+let salthash = process.argv[4];
+
+const cloneBytecode = [
+  "0x3d602d80600a3d3981f3363d3d373d3d3d363d73",
+  implementationAddress.replace(/0x/, "").toLowerCase(),
+  "5af43d82803e903d91602b57fd5bf3",
+].join("");
+
+const initCodeHash = ethers.utils.solidityKeccak256(["bytes"], [cloneBytecode]);
+
+const create2Address = ethers.utils.getCreate2Address(signer, salthash, initCodeHash);
+
+process.stdout.write(create2Address);
+// process.stdout.write(ethers.utils.defaultAbiCoder.encode(["bytes32"], [create2Address]));