@zoralabs/coins 2.4.0 → 2.4.1

package/test/utils/BaseTest.sol

@@ -1,6 +1,7 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.13;
 
+import {V4TestSetup} from "./V4TestSetup.sol";
 import "forge-std/Test.sol";
 
 import {OwnableUpgradeable} from "@openzeppelin/contracts-upgradeable/access/OwnableUpgradeable.sol";
@@ -29,7 +30,7 @@ import {IPoolManager} from "@uniswap/v4-core/src/interfaces/IPoolManager.sol";
 import {ZoraV4CoinHook} from "../../src/hooks/ZoraV4CoinHook.sol";
 import {HooksDeployment} from "../../src/libs/HooksDeployment.sol";
 import {CoinConstants} from "../../src/libs/CoinConstants.sol";
-import {ProxyShim} from "./ProxyShim.sol";
+import {ProxyShim} from "../../src/utils/ProxyShim.sol";
 import {ICoin} from "../../src/interfaces/ICoin.sol";
 import {UniV4SwapHelper} from "../../src/libs/UniV4SwapHelper.sol";
 import {IPermit2} from "permit2/src/interfaces/IPermit2.sol";
@@ -59,426 +60,26 @@ import {MockERC20} from "../mocks/MockERC20.sol";
 import {MockAirlock} from "../mocks/MockAirlock.sol";
 import {SimpleERC20} from "../mocks/SimpleERC20.sol";
 
-contract BaseTest is Test, ContractAddresses {
-    using stdStorage for StdStorage;
-
-    int24 internal constant USDC_TICK_LOWER = 57200;
-    int24 internal constant DEFAULT_DISCOVERY_TICK_LOWER = CoinConstants.DEFAULT_DISCOVERY_TICK_LOWER;
-    int24 internal constant DEFAULT_DISCOVERY_TICK_UPPER = CoinConstants.DEFAULT_DISCOVERY_TICK_UPPER;
-    uint16 internal constant DEFAULT_NUM_DISCOVERY_POSITIONS = CoinConstants.DEFAULT_NUM_DISCOVERY_POSITIONS;
-    uint256 internal constant DEFAULT_DISCOVERY_SUPPLY_SHARE = CoinConstants.DEFAULT_DISCOVERY_SUPPLY_SHARE;
-
-    struct Users {
-        address factoryOwner;
-        address feeRecipient;
-        address creator;
-        address platformReferrer;
-        address buyer;
-        address seller;
-        address coinRecipient;
-        address tradeReferrer;
-        address dopplerRecipient;
-    }
-
-    uint256 internal forkId;
-    IERC20Metadata internal zoraToken;
-    IERC20Metadata internal usdc;
-    IWETH internal weth;
-
-    ProtocolRewards internal protocolRewards;
-    IUniswapV3Factory internal v3Factory;
-    INonfungiblePositionManager internal nonfungiblePositionManager;
-    IPermit2 internal permit2;
-    IUniversalRouter internal router;
-    IPoolManager internal poolManager;
-    IV4Quoter internal quoter;
-    ContentCoin internal coinV4;
-
-    ISwapRouter internal swapRouter;
-    IAirlock internal airlock;
-    Users internal users;
-
-    // Coin internal coinV3Impl;
-    ContentCoin internal coinV4Impl;
-    CreatorCoin internal creatorCoinImpl;
-    ZoraFactoryImpl internal factoryImpl;
-    IZoraFactory internal factory;
-    ZoraV4CoinHook internal hook;
-    HookUpgradeGate internal hookUpgradeGate;
-    ZoraHookRegistry internal zoraHookRegistry;
-
-    function _defaultPoolConfig(address currency) internal pure returns (bytes memory) {
-        return CoinConfigurationVersions.defaultDopplerMultiCurveUniV4(currency);
-    }
-
-    function _deployV4Coin(address currency) internal returns (ICoin) {
-        bytes32 salt = keccak256(abi.encode(bytes("randomSalt")));
-        return _deployV4Coin(currency, address(0), salt);
-    }
-
-    string constant DEFAULT_NAME = "Testcoin";
-    string constant DEFAULT_SYMBOL = "TEST";
-
-    function _deployV4Coin(address currency, address createReferral, bytes32 salt) internal returns (ICoin) {
-        address[] memory owners = new address[](1);
-        owners[0] = users.creator;
-
-        bytes memory poolConfig = _defaultPoolConfig(currency);
-
-        vm.prank(users.creator);
-        (address coinAddress, ) = factory.deploy(
-            users.creator,
-            owners,
-            "https://test.com",
-            DEFAULT_NAME,
-            DEFAULT_SYMBOL,
-            poolConfig,
-            createReferral,
-            address(0),
-            bytes(""),
-            salt
-        );
-
-        coinV4 = ContentCoin(payable(coinAddress));
-        return coinV4;
-    }
-
-    function _deployV4Coin() internal returns (ICoin) {
-        // deploy with eth and no referral
-        return _deployV4Coin(address(0), address(0), bytes32(0));
-    }
-
-    function _deployCoinUSDCPair() internal {
-        bytes memory poolConfig_ = _defaultPoolConfig(USDC_ADDRESS);
-        vm.prank(users.creator);
-        (address coinAddress, ) = factory.deploy(
-            users.creator,
-            _getDefaultOwners(),
-            "https://test.com",
-            "Testcoin",
-            "TEST",
-            poolConfig_,
-            users.platformReferrer,
-            0
-        );
-
-        vm.label(coinAddress, "COIN");
-    }
-
-    function _swapSomeCurrencyForCoin(ICoin _coin, address currency, uint128 amountIn, address trader) internal {
-        _swapSomeCurrencyForCoin(_coin.getPoolKey(), _coin, currency, amountIn, trader);
-    }
-
-    function _swapSomeCurrencyForCoin(PoolKey memory poolKey, ICoin _coin, address currency, uint128 amountIn, address trader) internal {
-        uint128 minAmountOut = uint128(0);
-
-        (bytes memory commands, bytes[] memory inputs) = UniV4SwapHelper.buildExactInputSingleSwapCommand(
-            currency,
-            amountIn,
-            address(_coin),
-            minAmountOut,
-            poolKey,
-            bytes("")
-        );
-
-        vm.startPrank(trader);
-        if (currency != address(0)) {
-            UniV4SwapHelper.approveTokenWithPermit2(permit2, address(router), currency, amountIn, uint48(block.timestamp + 1 days));
-        }
-
-        uint256 value = currency == address(0) ? amountIn : 0;
-
-        // Execute the swap
-        uint256 deadline = block.timestamp + 20;
-        router.execute{value: value}(commands, inputs, deadline);
-
-        vm.stopPrank();
-    }
-
-    function _swapSomeCoinForCurrency(ICoin _coin, address currency, uint128 amountIn, address trader) internal {
-        uint128 minAmountOut = uint128(0);
-
-        (bytes memory commands, bytes[] memory inputs) = UniV4SwapHelper.buildExactInputSingleSwapCommand(
-            address(_coin),
-            amountIn,
-            currency,
-            minAmountOut,
-            _coin.getPoolKey(),
-            bytes("")
-        );
-
-        vm.startPrank(trader);
-        UniV4SwapHelper.approveTokenWithPermit2(permit2, address(router), address(_coin), amountIn, uint48(block.timestamp + 1 days));
-
-        // Execute the swap
-        uint256 deadline = block.timestamp + 20;
-        router.execute(commands, inputs, deadline);
-
-        vm.stopPrank();
-    }
-
-    function _deployFeeEstimatorHook(address hooks) internal {
-        // Deploy a new lookup with the same trusted senders
-        address[] memory trustedMessageSenders = new address[](2);
-        trustedMessageSenders[0] = UNIVERSAL_ROUTER;
-        trustedMessageSenders[1] = V4_POSITION_MANAGER;
-        ITrustedMsgSenderProviderLookup newLookup = TrustedSenderTestHelper.deployTrustedMessageSender(users.factoryOwner, trustedMessageSenders);
-
-        deployCodeTo(
-            "FeeEstimatorHook.sol",
-            HooksDeployment.hookConstructorArgs(address(poolManager), address(factory), newLookup, address(hookUpgradeGate)),
-            hooks
-        );
-    }
-
-    function getSalt(ITrustedMsgSenderProviderLookup trustedMsgSenderLookup) public returns (bytes32 hookSalt) {
-        address deployer = address(this);
-
-        (, hookSalt) = HooksDeployment.mineForCoinSalt(deployer, V4_POOL_MANAGER, address(factory), trustedMsgSenderLookup, address(hookUpgradeGate));
-    }
-
-    function _deployHooks() internal {
-        address[] memory trustedMessageSenders = new address[](2);
-        trustedMessageSenders[0] = UNIVERSAL_ROUTER;
-        trustedMessageSenders[1] = V4_POSITION_MANAGER;
-
-        ITrustedMsgSenderProviderLookup trustedMsgSenderLookup = TrustedSenderTestHelper.deployTrustedMessageSender(users.factoryOwner, trustedMessageSenders);
-
-        bytes32 hookSalt = getSalt(trustedMsgSenderLookup);
-
-        hook = ZoraV4CoinHook(
-            payable(
-                address(
-                    HooksDeployment.deployHookWithSalt(
-                        HooksDeployment.makeHookCreationCode(
-                            V4_POOL_MANAGER,
-                            address(factory),
-                            ITrustedMsgSenderProviderLookup(address(trustedMsgSenderLookup)),
-                            address(hookUpgradeGate)
-                        ),
-                        hookSalt
-                    )
-                )
-            )
-        );
-    }
-
+/**
+ * @title BaseTest
+ * @notice Coins-specific test utilities extending V4TestSetup
+ * @dev This contract adds coins-specific reward calculations on top of shared V4 infrastructure
+ */
+contract BaseTest is V4TestSetup {
     function setUp() public virtual {
         setUpWithBlockNumber(28415528);
     }
 
-    function setUpWithBlockNumber(uint256 forkBlockNumber) public {
-        forkId = vm.createSelectFork("base", forkBlockNumber);
-
-        weth = IWETH(WETH_ADDRESS);
-        usdc = IERC20Metadata(USDC_ADDRESS);
-        zoraToken = IERC20Metadata(ZORA_TOKEN_ADDRESS);
-        v3Factory = IUniswapV3Factory(V3_FACTORY);
-        nonfungiblePositionManager = INonfungiblePositionManager(NONFUNGIBLE_POSITION_MANAGER);
-        swapRouter = ISwapRouter(SWAP_ROUTER);
-        airlock = IAirlock(DOPPLER_AIRLOCK);
-        protocolRewards = new ProtocolRewards();
-        permit2 = IPermit2(V4_PERMIT2);
-        router = IUniversalRouter(UNIVERSAL_ROUTER);
-        poolManager = IPoolManager(V4_POOL_MANAGER);
-        quoter = IV4Quoter(V4_QUOTER);
-        users = Users({
-            factoryOwner: makeAddr("factoryOwner"),
-            feeRecipient: makeAddr("feeRecipient"),
-            creator: makeAddr("creator"),
-            platformReferrer: makeAddr("platformReferrer"),
-            buyer: makeAddr("buyer"),
-            seller: makeAddr("seller"),
-            coinRecipient: makeAddr("coinRecipient"),
-            tradeReferrer: makeAddr("tradeReferrer"),
-            dopplerRecipient: makeAddr("dopplerRecipient")
-        });
-
-        ProxyShim mockUpgradeableImpl = new ProxyShim();
-        factory = IZoraFactory(address(new ZoraFactory(address(mockUpgradeableImpl))));
-
-        hookUpgradeGate = new HookUpgradeGate(users.factoryOwner);
-
-        zoraHookRegistry = new ZoraHookRegistry();
-
-        address[] memory initialOwners = new address[](2);
-        initialOwners[0] = users.factoryOwner;
-        initialOwners[1] = address(factory);
-        zoraHookRegistry.initialize(initialOwners);
-
-        _deployHooks();
-
-        coinV4Impl = new ContentCoin(users.feeRecipient, address(protocolRewards), IPoolManager(V4_POOL_MANAGER), DOPPLER_AIRLOCK);
-
-        creatorCoinImpl = new CreatorCoin(users.feeRecipient, address(protocolRewards), IPoolManager(V4_POOL_MANAGER), DOPPLER_AIRLOCK);
-
-        factoryImpl = new ZoraFactoryImpl(address(coinV4Impl), address(creatorCoinImpl), address(hook), address(zoraHookRegistry));
-        UUPSUpgradeable(address(factory)).upgradeToAndCall(address(factoryImpl), "");
-        factory = IZoraFactory(address(factory));
-
-        ZoraFactoryImpl(address(factory)).initialize(users.factoryOwner);
-
-        vm.label(address(factory), "ZORA_FACTORY");
-        vm.label(address(protocolRewards), "PROTOCOL_REWARDS");
-        vm.label(address(nonfungiblePositionManager), "NONFUNGIBLE_POSITION_MANAGER");
-        vm.label(address(v3Factory), "V3_FACTORY");
-        vm.label(address(swapRouter), "SWAP_ROUTER");
-        vm.label(address(weth), "WETH");
-        vm.label(address(usdc), "USDC");
-        vm.label(address(airlock), "AIRLOCK");
-        vm.label(address(zoraToken), "$ZORA");
-        vm.label(address(V4_POOL_MANAGER), "V4_POOL_MANAGER");
-        vm.label(address(V4_POSITION_MANAGER), "V4_POSITION_MANAGER");
-        vm.label(address(V4_QUOTER), "V4_QUOTER");
-        vm.label(address(V4_PERMIT2), "V4_PERMIT2");
-        vm.label(address(UNIVERSAL_ROUTER), "UNIVERSAL_ROUTER");
-        vm.label(address(hook), "HOOK");
-    }
-
-    function setUpNonForked() public {
-        // Initialize users first
-        users = Users({
-            factoryOwner: makeAddr("factoryOwner"),
-            feeRecipient: makeAddr("feeRecipient"),
-            creator: makeAddr("creator"),
-            platformReferrer: makeAddr("platformReferrer"),
-            buyer: makeAddr("buyer"),
-            seller: makeAddr("seller"),
-            coinRecipient: makeAddr("coinRecipient"),
-            tradeReferrer: makeAddr("tradeReferrer"),
-            dopplerRecipient: makeAddr("dopplerRecipient")
-        });
-
-        // Deploy mock airlock with the dopplerRecipient as owner (for doppler rewards)
-        MockAirlock mockAirlock = new MockAirlock(users.dopplerRecipient);
-
-        // Deploy V4 infrastructure using hookmate
-        _deployV4InfrastructureNonForked();
-
-        // Deploy mock ZORA token at the correct address
-        deployCodeTo("SimpleERC20.sol:SimpleERC20", abi.encode("ZORA", "$ZORA"), ZORA_TOKEN_ADDRESS);
-        zoraToken = IERC20Metadata(ZORA_TOKEN_ADDRESS);
-
-        // Fund the pool manager with ZORA tokens
-        deal(address(zoraToken), address(poolManager), 1_000_000_000e18);
-
-        // Deploy protocol rewards
-        protocolRewards = new ProtocolRewards();
-
-        // Deploy factory proxy
-        ProxyShim mockUpgradeableImpl = new ProxyShim();
-        factory = IZoraFactory(address(new ZoraFactory(address(mockUpgradeableImpl))));
-
-        // Deploy hook upgrade gate
-        hookUpgradeGate = new HookUpgradeGate(users.factoryOwner);
-
-        // Deploy zora hook registry
-        zoraHookRegistry = new ZoraHookRegistry();
-        address[] memory initialOwners = new address[](2);
-        initialOwners[0] = users.factoryOwner;
-        initialOwners[1] = address(factory);
-        zoraHookRegistry.initialize(initialOwners);
-
-        // Deploy hooks for non-forked environment
-        _deployHooksNonForked();
-
-        // Deploy coin implementations
-        coinV4Impl = new ContentCoin(users.feeRecipient, address(protocolRewards), poolManager, address(mockAirlock));
-        creatorCoinImpl = new CreatorCoin(users.feeRecipient, address(protocolRewards), poolManager, address(mockAirlock));
-
-        // Deploy and initialize factory implementation
-        factoryImpl = new ZoraFactoryImpl(address(coinV4Impl), address(creatorCoinImpl), address(hook), address(zoraHookRegistry));
-        UUPSUpgradeable(address(factory)).upgradeToAndCall(address(factoryImpl), "");
-        ZoraFactoryImpl(address(factory)).initialize(users.factoryOwner);
-
-        // Labels for easier debugging
-        vm.label(address(factory), "ZORA_FACTORY");
-        vm.label(address(protocolRewards), "PROTOCOL_REWARDS");
-        vm.label(address(poolManager), "V4_POOL_MANAGER");
-        vm.label(address(permit2), "V4_PERMIT2");
-        vm.label(address(router), "UNIVERSAL_ROUTER");
-        vm.label(address(hook), "HOOK");
-        vm.label(address(mockAirlock), "MOCK_AIRLOCK");
-    }
-
-    function _deployV4InfrastructureNonForked() internal {
-        // Deploy Permit2 to canonical address
-        _deployPermit2NonForked();
-
-        // Deploy PoolManager
-        _deployPoolManagerNonForked();
-
-        // Deploy Quoter
-        _deployQuoterNonForked();
-
-        // Deploy Universal Router
-        _deployUniversalRouterNonForked();
-    }
-
-    function _deployPermit2NonForked() internal {
-        address permit2Address = AddressConstants.getPermit2Address();
-
-        if (permit2Address.code.length > 0) {
-            // Permit2 is already deployed
-        } else {
-            address tempDeployAddress = address(Permit2Deployer.deploy());
-            vm.etch(permit2Address, tempDeployAddress.code);
-        }
-
-        permit2 = IPermit2(permit2Address);
-        vm.label(address(permit2), "V4_PERMIT2");
+    function setUpWithBlockNumber(uint256 forkBlockNumber) public virtual {
+        _setUpWithBlockNumber(forkBlockNumber);
     }
 
-    function _deployPoolManagerNonForked() internal {
-        if (block.chainid == 31337) {
-            poolManager = IPoolManager(address(V4PoolManagerDeployer.deploy(address(0x4444))));
-        } else {
-            poolManager = IPoolManager(AddressConstants.getPoolManagerAddress(block.chainid));
-        }
-
-        deal(address(poolManager), 10000 ether);
-        vm.label(address(poolManager), "V4_POOL_MANAGER");
+    function setUpNonForked() public virtual {
+        _setUpNonForked();
     }
 
-    function _deployQuoterNonForked() internal {
-        quoter = IV4Quoter(V4QuoterDeployer.deploy(address(poolManager)));
-        vm.label(address(quoter), "V4_QUOTER");
-    }
-
-    function _deployUniversalRouterNonForked() internal {
-        RouterParameters memory params = RouterParameters({
-            permit2: address(permit2),
-            weth9: address(0),
-            v2Factory: address(0),
-            v3Factory: address(0),
-            pairInitCodeHash: bytes32(0),
-            poolInitCodeHash: bytes32(0),
-            v4PoolManager: address(poolManager),
-            v3NFTPositionManager: address(0),
-            v4PositionManager: address(0)
-        });
-        router = IUniversalRouter(UniversalRouterDeployer.deploy(params));
-        vm.label(address(router), "UNIVERSAL_ROUTER");
-    }
-
-    function _deployHooksNonForked() internal {
-        address[] memory trustedMessageSenders = new address[](1);
-        trustedMessageSenders[0] = address(router);
-
-        ITrustedMsgSenderProviderLookup trustedMsgSenderLookup = TrustedSenderTestHelper.deployTrustedMessageSender(users.factoryOwner, trustedMessageSenders);
-
-        // Use proper salt mining for hook deployment
-        address deployer = address(this);
-        (, bytes32 salt) = HooksDeployment.mineForCoinSalt(deployer, address(poolManager), address(factory), trustedMsgSenderLookup, address(hookUpgradeGate));
-
-        bytes memory hookCreationCode = HooksDeployment.makeHookCreationCode(
-            address(poolManager),
-            address(factory),
-            trustedMsgSenderLookup,
-            address(hookUpgradeGate)
-        );
-
-        hook = ZoraV4CoinHook(payable(DeployHelper.deploy(hookCreationCode, salt)));
+    function setUpNonForked(address limitOrderBook) public virtual {
+        _setUpNonForked(limitOrderBook);
     }
 
     struct TradeRewards {
@@ -505,11 +106,6 @@ contract BaseTest is Test, ContractAddresses {
             });
     }
 
-    function _calculateExpectedFee(uint256 ethAmount) internal pure returns (uint256) {
-        uint256 feeBps = 100; // 1%
-        return (ethAmount * feeBps) / 10_000;
-    }
-
     function _calculateMarketRewards(uint256 ethAmount) internal pure returns (MarketRewards memory) {
         uint256 creator = (ethAmount * 5000) / 10_000;
         uint256 platformReferrer = (ethAmount * 2500) / 10_000;
@@ -518,34 +114,4 @@ contract BaseTest is Test, ContractAddresses {
 
         return MarketRewards({creator: creator, platformReferrer: platformReferrer, doppler: doppler, protocol: protocol});
     }
-
-    function dealUSDC(address to, uint256 numUSDC) internal returns (uint256) {
-        uint256 amount = numUSDC * 1e6;
-        deal(address(usdc), to, amount);
-        return amount;
-    }
-
-    function _getDefaultOwners() internal view returns (address[] memory owners) {
-        owners = new address[](1);
-        owners[0] = users.creator;
-    }
-
-    function dopplerFeeRecipient() internal view returns (address) {
-        return airlock.owner();
-    }
-
-    function _generatePoolConfig(address currency_) internal pure returns (bytes memory) {
-        return CoinConfigurationVersions.defaultDopplerMultiCurveUniV4(currency_);
-    }
-
-    function _generatePoolConfig(
-        uint8 version_,
-        address currency_,
-        int24 tickLower_,
-        int24 tickUpper_,
-        uint16 numDiscoveryPositions_,
-        uint256 maxDiscoverySupplyShare_
-    ) internal pure returns (bytes memory) {
-        return abi.encode(version_, currency_, tickLower_, tickUpper_, numDiscoveryPositions_, maxDiscoverySupplyShare_);
-    }
 }

package/test/utils/FeeEstimatorHook.sol

@@ -4,6 +4,8 @@ pragma solidity ^0.8.13;
 import {ZoraV4CoinHook} from "../../src/hooks/ZoraV4CoinHook.sol";
 import {IPoolManager, PoolKey} from "@uniswap/v4-core/src/interfaces/IPoolManager.sol";
 import {IDeployedCoinVersionLookup} from "../../src/interfaces/IDeployedCoinVersionLookup.sol";
+import {IZoraLimitOrderBookCoinsInterface} from "../../src/interfaces/IZoraLimitOrderBookCoinsInterface.sol";
+import {IZoraHookRegistry} from "../../src/interfaces/IZoraHookRegistry.sol";
 import {IHasRewardsRecipients} from "../../src/interfaces/IHasRewardsRecipients.sol";
 import {Currency} from "@uniswap/v4-core/src/types/Currency.sol";
 import {SwapParams} from "@uniswap/v4-core/src/types/PoolOperation.sol";
@@ -35,8 +37,10 @@ contract FeeEstimatorHook is ZoraV4CoinHook {
         IPoolManager _poolManager,
         IDeployedCoinVersionLookup _coinVersionLookup,
         ITrustedMsgSenderProviderLookup trustedMsgSenderLookup,
-        IHooksUpgradeGate upgradeGate
-    ) ZoraV4CoinHook(_poolManager, _coinVersionLookup, trustedMsgSenderLookup, upgradeGate) {}
+        IHooksUpgradeGate upgradeGate,
+        IZoraLimitOrderBookCoinsInterface zoraLimitOrderBook,
+        IZoraHookRegistry zoraHookRegistry
+    ) ZoraV4CoinHook(_poolManager, _coinVersionLookup, trustedMsgSenderLookup, upgradeGate, zoraLimitOrderBook, zoraHookRegistry) {}
 
     FeeEstimatorState public feeState;