@zoralabs/coins 2.4.0 → 2.5.0

package/src/deployment/CoinsDeployerBase.sol

@@ -1,297 +0,0 @@
-// SPDX-License-Identifier: MIT
-pragma solidity ^0.8.28;
-
-import "forge-std/Script.sol";
-
-import {ProxyDeployerScript, DeterministicContractConfig, DeterministicDeployerAndCaller} from "@zoralabs/shared-contracts/deployment/ProxyDeployerScript.sol";
-import {UUPSUpgradeable} from "@openzeppelin/contracts-upgradeable/proxy/utils/UUPSUpgradeable.sol";
-import {ZoraFactoryImpl} from "../ZoraFactoryImpl.sol";
-import {IVersionedContract} from "@zoralabs/shared-contracts/interfaces/IVersionedContract.sol";
-// import {BuySupplyWithSwapRouterHook} from "../hooks/deployment/BuySupplyWithSwapRouterHook.sol";
-import {IZoraFactory} from "../interfaces/IZoraFactory.sol";
-import {ContentCoin} from "../ContentCoin.sol";
-import {IHooks} from "@uniswap/v4-core/src/interfaces/IHooks.sol";
-import {IPoolManager} from "@uniswap/v4-core/src/interfaces/IPoolManager.sol";
-import {ZoraFactory} from "../proxy/ZoraFactory.sol";
-import {HooksDeployment} from "../libs/HooksDeployment.sol";
-import {ProxyShim} from "../../test/utils/ProxyShim.sol";
-import {CreatorCoin} from "../CreatorCoin.sol";
-import {Create2} from "@openzeppelin/contracts/utils/Create2.sol";
-import {HookUpgradeGate} from "../hooks/HookUpgradeGate.sol";
-import {BuySupplyWithV4SwapHook} from "../hooks/deployment/BuySupplyWithV4SwapHook.sol";
-import {TrustedMsgSenderProviderLookup} from "../utils/TrustedMsgSenderProviderLookup.sol";
-import {ITrustedMsgSenderProviderLookup} from "../interfaces/ITrustedMsgSenderProviderLookup.sol";
-
-contract CoinsDeployerBase is ProxyDeployerScript {
-    address internal constant PROTOCOL_REWARDS = 0x7777777F279eba3d3Ad8F4E708545291A6fDBA8B;
-    address internal constant ZORA = 0x1111111111166b7FE7bd91427724B487980aFc69;
-
-    using stdJson for string;
-
-    struct CoinsDeployment {
-        // Factory
-        address zoraFactory;
-        address zoraFactoryImpl;
-        // Implementation
-        address coinV3Impl;
-        address coinV4Impl;
-        address creatorCoinImpl;
-        string coinVersion;
-        // hooks
-        address buySupplyWithSwapRouterHook;
-        address zoraV4CoinHook;
-        address hookUpgradeGate;
-        // trusted sender lookup
-        address trustedMsgSenderLookup;
-        // Hook deployment salt (for deterministic deployment)
-        bytes32 zoraV4CoinHookSalt;
-        bool isDev;
-        // Hook registry
-        address zoraHookRegistry;
-    }
-
-    function addressesFile() internal view returns (string memory) {
-        return addressesFile(false);
-    }
-
-    function addressesFile(bool dev) internal view returns (string memory) {
-        if (dev) {
-            return string.concat("./addresses/dev/", vm.toString(block.chainid), ".json");
-        }
-        return string.concat("./addresses/", vm.toString(block.chainid), ".json");
-    }
-
-    function saveDeployment(CoinsDeployment memory deployment) internal {
-        string memory objectKey = "config";
-
-        vm.serializeAddress(objectKey, "ZORA_FACTORY", deployment.zoraFactory);
-        vm.serializeAddress(objectKey, "ZORA_FACTORY_IMPL", deployment.zoraFactoryImpl);
-        vm.serializeString(objectKey, "COIN_VERSION", deployment.coinVersion);
-        vm.serializeAddress(objectKey, "BUY_SUPPLY_WITH_SWAP_ROUTER_HOOK", deployment.buySupplyWithSwapRouterHook);
-        vm.serializeAddress(objectKey, "COIN_V3_IMPL", deployment.coinV3Impl);
-        vm.serializeAddress(objectKey, "ZORA_V4_COIN_HOOK", deployment.zoraV4CoinHook);
-        vm.serializeBytes32(objectKey, "ZORA_V4_COIN_HOOK_SALT", deployment.zoraV4CoinHookSalt);
-        vm.serializeAddress(objectKey, "CREATOR_COIN_IMPL", deployment.creatorCoinImpl);
-        vm.serializeAddress(objectKey, "HOOK_UPGRADE_GATE", deployment.hookUpgradeGate);
-        vm.serializeAddress(objectKey, "ZORA_HOOK_REGISTRY", deployment.zoraHookRegistry);
-        vm.serializeAddress(objectKey, "TRUSTED_MSG_SENDER_LOOKUP", deployment.trustedMsgSenderLookup);
-        string memory result = vm.serializeAddress(objectKey, "COIN_V4_IMPL", deployment.coinV4Impl);
-
-        vm.writeJson(result, addressesFile(deployment.isDev));
-    }
-
-    function readDeployment() internal returns (CoinsDeployment memory deployment) {
-        return readDeployment(false);
-    }
-
-    function readDeployment(bool dev) internal returns (CoinsDeployment memory deployment) {
-        string memory file = addressesFile(dev);
-        deployment.isDev = dev;
-        if (!vm.exists(file)) {
-            return deployment;
-        }
-        string memory json = vm.readFile(file);
-
-        deployment.zoraFactory = readAddressOrDefaultToZero(json, "ZORA_FACTORY");
-        deployment.zoraFactoryImpl = readAddressOrDefaultToZero(json, "ZORA_FACTORY_IMPL");
-        deployment.coinV3Impl = readAddressOrDefaultToZero(json, "COIN_V3_IMPL");
-        deployment.coinV4Impl = readAddressOrDefaultToZero(json, "COIN_V4_IMPL");
-        deployment.coinVersion = readStringOrDefaultToEmpty(json, "COIN_VERSION");
-        deployment.buySupplyWithSwapRouterHook = readAddressOrDefaultToZero(json, "BUY_SUPPLY_WITH_SWAP_ROUTER_HOOK");
-        deployment.zoraV4CoinHook = readAddressOrDefaultToZero(json, "ZORA_V4_COIN_HOOK");
-        deployment.zoraV4CoinHookSalt = readBytes32OrDefaultToZero(json, "ZORA_V4_COIN_HOOK_SALT");
-        deployment.creatorCoinImpl = readAddressOrDefaultToZero(json, "CREATOR_COIN_IMPL");
-        deployment.hookUpgradeGate = readAddressOrDefaultToZero(json, "HOOK_UPGRADE_GATE");
-        deployment.zoraHookRegistry = readAddressOrDefaultToZero(json, "ZORA_HOOK_REGISTRY");
-        deployment.trustedMsgSenderLookup = readAddressOrDefaultToZero(json, "TRUSTED_MSG_SENDER_LOOKUP");
-    }
-
-    function deployCoinV4Impl() internal returns (ContentCoin) {
-        return
-            new ContentCoin({
-                protocolRewardRecipient_: getZoraRecipient(),
-                protocolRewards_: PROTOCOL_REWARDS,
-                poolManager_: IPoolManager(getUniswapV4PoolManager()),
-                airlock_: getDopplerAirlock()
-            });
-    }
-
-    function deployCreatorCoinImpl() internal returns (CreatorCoin) {
-        return
-            new CreatorCoin({
-                protocolRewardRecipient_: getZoraRecipient(),
-                protocolRewards_: PROTOCOL_REWARDS,
-                poolManager_: IPoolManager(getUniswapV4PoolManager()),
-                airlock_: getDopplerAirlock()
-            });
-    }
-
-    function deployZoraFactoryImpl(address coinV4Impl_, address creatorCoinImpl_, address hook_, address zoraHookRegistry_) internal returns (ZoraFactoryImpl) {
-        return new ZoraFactoryImpl({coinV4Impl_: coinV4Impl_, creatorCoinImpl_: creatorCoinImpl_, hook_: hook_, zoraHookRegistry_: zoraHookRegistry_});
-    }
-
-    function deployBuySupplyWithV4SwapHook(CoinsDeployment memory deployment) internal returns (BuySupplyWithV4SwapHook) {
-        return
-            new BuySupplyWithV4SwapHook({
-                _factory: IZoraFactory(deployment.zoraFactory),
-                _swapRouter: getUniswapSwapRouter(),
-                _poolManager: getUniswapV4PoolManager()
-            });
-    }
-
-    function deployUpgradeGate(CoinsDeployment memory deployment) internal returns (CoinsDeployment memory) {
-        deployment.hookUpgradeGate = address(new HookUpgradeGate(getProxyAdmin()));
-
-        return deployment;
-    }
-
-    function deployTrustedMsgSenderLookup(CoinsDeployment memory deployment) internal returns (CoinsDeployment memory) {
-        // Deploy the contract directly using constructor
-        deployment.trustedMsgSenderLookup = address(new TrustedMsgSenderProviderLookup(getDefaultTrustedMessageSenders(), getProxyAdmin()));
-
-        return deployment;
-    }
-
-    function deployZoraV4CoinHook(CoinsDeployment memory deployment) internal returns (IHooks hook, bytes32 salt) {
-        require(deployment.trustedMsgSenderLookup != address(0), "Trusted message sender lookup not deployed");
-
-        return
-            HooksDeployment.deployHookWithExistingOrNewSalt(
-                HooksDeployment.FOUNDRY_SCRIPT_ADDRESS,
-                HooksDeployment.makeHookCreationCode(
-                    getUniswapV4PoolManager(),
-                    deployment.zoraFactory,
-                    ITrustedMsgSenderProviderLookup(deployment.trustedMsgSenderLookup),
-                    deployment.hookUpgradeGate
-                ),
-                deployment.zoraV4CoinHookSalt
-            );
-    }
-
-    function getDefaultTrustedMessageSenders() internal view returns (address[] memory) {
-        address[] memory trustedMessageSenders = new address[](2);
-        trustedMessageSenders[0] = getUniswapUniversalRouter();
-        trustedMessageSenders[1] = getUniswapV4PositionManager();
-        return trustedMessageSenders;
-    }
-
-    function deployFactoryImpl(CoinsDeployment memory deployment) internal returns (address) {
-        return
-            address(
-                deployZoraFactoryImpl({
-                    coinV4Impl_: deployment.coinV4Impl,
-                    creatorCoinImpl_: deployment.creatorCoinImpl,
-                    hook_: deployment.zoraV4CoinHook,
-                    zoraHookRegistry_: deployment.zoraHookRegistry
-                })
-            );
-    }
-
-    function deployImpls(CoinsDeployment memory deployment) internal returns (CoinsDeployment memory) {
-        // Deploy implementation contracts
-
-        // Deploy trusted message sender lookup first
-        deployment = deployTrustedMsgSenderLookup(deployment);
-
-        // Deploy hook first, then use its address for coin v4 impl
-        console.log("deploying content coin hook");
-        (IHooks zoraV4CoinHook, bytes32 usedSalt) = deployZoraV4CoinHook(deployment);
-        deployment.zoraV4CoinHook = address(zoraV4CoinHook);
-        deployment.zoraV4CoinHookSalt = usedSalt;
-
-        deployment.coinV4Impl = address(deployCoinV4Impl());
-        deployment.creatorCoinImpl = address(deployCreatorCoinImpl());
-        deployment.zoraFactoryImpl = deployFactoryImpl(deployment);
-        deployment.coinVersion = IVersionedContract(deployment.coinV4Impl).contractVersion();
-        // deployment.buySupplyWithSwapRouterHook = address(deployBuySupplyWithSwapRouterHook(deployment));
-
-        return deployment;
-    }
-
-    function deployHooks(CoinsDeployment memory deployment) internal returns (CoinsDeployment memory) {
-        // Deploy trusted message sender lookup first
-        deployment = deployTrustedMsgSenderLookup(deployment);
-
-        // Deploy hook first, then use its address for coin v4 impl
-        (IHooks zoraV4CoinHook, bytes32 usedSalt) = deployZoraV4CoinHook(deployment);
-        deployment.zoraV4CoinHook = address(zoraV4CoinHook);
-        deployment.zoraV4CoinHookSalt = usedSalt;
-
-        deployment.zoraFactoryImpl = deployFactoryImpl(deployment);
-
-        return deployment;
-    }
-
-    function deployZoraDeterministic(CoinsDeployment memory deployment, DeterministicDeployerAndCaller deployer) internal {
-        // read previously saved deterministic config
-        DeterministicContractConfig memory zoraConfig = readDeterministicContractConfig("zoraFactory");
-
-        deployment = deployImpls(deployment);
-
-        if (deployment.zoraFactoryImpl.code.length == 0) {
-            revert("Factory Impl not yet deployed. Make sure to deploy it with DeployImpl.s.sol");
-        }
-
-        // build upgrade to and call for factory, with init call
-        bytes memory upgradeToAndCall = abi.encodeWithSelector(
-            UUPSUpgradeable.upgradeToAndCall.selector,
-            deployment.zoraFactoryImpl,
-            abi.encodeWithSelector(ZoraFactoryImpl.initialize.selector, getProxyAdmin())
-        );
-
-        // sign deployment with turnkey account
-        bytes memory signature = signDeploymentWithTurnkey(zoraConfig, upgradeToAndCall, deployer);
-
-        printVerificationCommand(zoraConfig);
-
-        deployment.zoraFactory = deployer.permitSafeCreate2AndCall(
-            signature,
-            zoraConfig.salt,
-            zoraConfig.creationCode,
-            upgradeToAndCall,
-            zoraConfig.deployedAddress
-        );
-
-        // validate that the zora factory owner is the proxy admin
-        require(ZoraFactoryImpl(deployment.zoraFactory).owner() == getProxyAdmin(), "Zora factory owner is not the proxy admin");
-    }
-
-    function deployDevFactory(CoinsDeployment memory deployment) internal returns (ZoraFactory devFactory) {
-        address owner = 0x63545B401283c993320A5b886ecF0fc6CB5668a9;
-
-        ProxyShim shim = new ProxyShim();
-
-        deployment.zoraFactory = address(new ZoraFactory(address(shim)));
-
-        deployment = deployImpls(deployment);
-
-        UUPSUpgradeable(deployment.zoraFactory).upgradeToAndCall(deployment.zoraFactoryImpl, "");
-
-        ZoraFactoryImpl(deployment.zoraFactory).initialize(owner);
-
-        saveDeployment(deployment);
-
-        return ZoraFactory(payable(deployment.zoraFactory));
-    }
-
-    function printUpgradeFactoryCommand(CoinsDeployment memory deployment) internal view {
-        // build upgrade to and call for factory, with init call
-        bytes memory call = abi.encodeWithSelector(UUPSUpgradeable.upgradeToAndCall.selector, deployment.zoraFactoryImpl, "");
-
-        address proxyAdmin = getProxyAdmin();
-
-        address target = address(deployment.zoraFactory);
-
-        // print the details for upgrading:
-
-        console.log("To upgrade the factory, this is the call information:");
-
-        console.log("Multisig:", proxyAdmin);
-        console.log("Target (the factory proxy):", target);
-        console.log("Upgrade call:");
-        console.logBytes(call);
-        console.log("Function to call: upgradeToAndCall");
-        // concat the args into a string, factoryImpl, ""
-        console.log("Args: ", string.concat(vm.toString(deployment.zoraFactoryImpl), ",", '"'));
-    }
-}