[CRE-14] flatten content coin hook + creator coin hook into a single hook (#1322)

* Apply suggested changes

Apply suggested changes

* merge both hooks into a single hook

* fixed merge conflicts

* remove added creator coin rewards

* Factory impl code update

* refactoring for arguments

* update constant definitions

* adding a new test for checking determining old coin type

* fix test

---------

Co-authored-by: Iain Nash <[email protected]>

Author: oveddan

.changeset/flatten-hooks-into-single-hook.md

@@ -0,0 +1,7 @@
+---
+"@zoralabs/coins": patch
+---
+
+Flatten hooks into single hook implementation
+
+Consolidates multiple hook contracts into a single unified hook for simplified architecture and better maintainability.

CLAUDE.md

@@ -249,14 +249,17 @@ Uses Graphite for branch management:
 Before working with the documentation, build the packages that are imported:
 
 1. **Install dependencies** from the root directory:
+
    ```bash
    pnpm install
    ```
 
 2. **Build packages** from the root directory:
+
    ```bash
    pnpm build:js
    ```
+
    Note: Documentation builds use `build:js` to avoid unnecessary contract compilation. If the build fails due to missing TypeScript dependencies, check individual package devDependencies.
 
 3. **Start docs development server**:
@@ -273,6 +276,7 @@ Some packages may fail during `build:js` if TypeScript is not available as a dev
 
 **Error Pattern**: `tsc: command not found` during tsup build
 **Solution**: Add TypeScript as devDependency to the failing package:
+
 ```json
 {
   "devDependencies": {
@@ -331,15 +335,15 @@ When renaming or moving documentation files, always add redirects to `docs/verce
 ```json
 {
   "source": "/coins/contracts/factory",
-  "destination": "/coins/contracts/creating-a-coin", 
+  "destination": "/coins/contracts/creating-a-coin",
   "permanent": true
 }
 ```
 
 #### Common Redirect Scenarios
 
 - **Page renamed**: Redirect old URL to new URL
-- **Page moved**: Redirect old path to new path  
+- **Page moved**: Redirect old path to new path
 - **Page removed**: Redirect to most relevant existing page
 - **Section reorganized**: Redirect old structure to new structure
 

packages/coins/script/PrintRegisterUpgradePath.s.sol

@@ -12,24 +12,17 @@ contract DeployScript is CoinsDeployerBase {
         CoinsDeployment memory deployment = readDeployment(false);
 
         address existingContentCoinHook = 0xd3D133469ADC85e01A4887404D8AC12d630e9040;
-        address existingCreatorCoinHook = 0xffF800B76768dA8AB6aab527021e4a6A91219040;
 
         address[] memory baseImpls = new address[](1);
         baseImpls[0] = existingContentCoinHook;
 
         bytes memory contentCoinUpgradeCall = abi.encodeWithSelector(IHooksUpgradeGate.registerUpgradePath.selector, baseImpls, deployment.zoraV4CoinHook);
 
-        baseImpls[0] = existingCreatorCoinHook;
-
-        bytes memory creatorCoinUpgradeCall = abi.encodeWithSelector(IHooksUpgradeGate.registerUpgradePath.selector, baseImpls, deployment.creatorCoinHook);
-
         printUpgradeFactoryCommand(deployment);
 
         console.log("register upgrade gate target", deployment.hookUpgradeGate);
 
         console.log("contentCoinUpgradeCall");
         console.logBytes(contentCoinUpgradeCall);
-        console.log("creatorCoinUpgradeCall");
-        console.logBytes(creatorCoinUpgradeCall);
     }
 }

packages/coins/script/TestBackingCoinSwap.s.sol

@@ -104,7 +104,6 @@ contract TestV4Swap is CoinsDeployerBase {
         vm.startBroadcast(trader);
 
         address createReferral = 0xC077e4cC02fa01A5b7fAca1acE9BBe9f5ac5Af9F;
-        address tradeReferral = 0xC077e4cC02fa01A5b7fAca1acE9BBe9f5ac5Af9F;
 
         ICoin backingCoin = _deployCoin(zora, trader, "Backing Coin", "BACK", "https://testc.com", createReferral, bytes32("creator"));
         ICoin contentCoin = _deployCoin(

packages/coins/script/TestV4Swap.s.sol

@@ -96,7 +96,6 @@ contract TestV4Swap is CoinsDeployerBase {
 
         vm.startBroadcast(trader);
 
-        address createReferral = 0xC077e4cC02fa01A5b7fAca1acE9BBe9f5ac5Af9F;
         address tradeReferral = 0xC077e4cC02fa01A5b7fAca1acE9BBe9f5ac5Af9F;
 
         // MockERC20 currency = _deployMockCurrency();

packages/coins/script/UpgradeFactoryImpl.s.sol

@@ -14,7 +14,6 @@ contract UpgradeFactoryImpl is CoinsDeployerBase {
             deployment.coinV4Impl,
             deployment.creatorCoinImpl,
             deployment.zoraV4CoinHook,
-            deployment.creatorCoinHook,
             deployment.zoraHookRegistry
         );
 

packages/coins/src/BaseCoin.sol

@@ -9,7 +9,7 @@ pragma solidity ^0.8.23;
 
 import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
 import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
-import {ICoin} from "./interfaces/ICoin.sol";
+import {ICoin, IHasTotalSupplyForPositions, IHasCoinType} from "./interfaces/ICoin.sol";
 import {IHasRewardsRecipients} from "./interfaces/IHasRewardsRecipients.sol";
 import {ICoinComments} from "./interfaces/ICoinComments.sol";
 import {IERC7572} from "./interfaces/IERC7572.sol";
@@ -89,28 +89,29 @@ abstract contract BaseCoin is ICoin, ContractVersionBase, ERC20PermitUpgradeable
 
     /**
      * @notice The constructor for the static Coin contract deployment shared across all Coins.
-     * @param _protocolRewardRecipient The address of the protocol reward recipient
-     * @param _protocolRewards The address of the protocol rewards contract
-     * @param _airlock The address of the Airlock contract
+     * @param protocolRewardRecipient_ The address of the protocol reward recipient
+     * @param protocolRewards_ The address of the protocol rewards contract
+     * @param poolManager_ The address of the pool manager
+     * @param airlock_ The address of the Airlock contract
      */
-    constructor(address _protocolRewardRecipient, address _protocolRewards, IPoolManager poolManager_, address _airlock) initializer {
-        if (_protocolRewardRecipient == address(0)) {
+    constructor(address protocolRewardRecipient_, address protocolRewards_, IPoolManager poolManager_, address airlock_) initializer {
+        if (protocolRewardRecipient_ == address(0)) {
             revert AddressZero();
         }
-        if (_protocolRewards == address(0)) {
+        if (protocolRewards_ == address(0)) {
             revert AddressZero();
         }
         if (address(poolManager_) == address(0)) {
             revert AddressZero();
         }
-        if (_airlock == address(0)) {
+        if (airlock_ == address(0)) {
             revert AddressZero();
         }
 
-        protocolRewardRecipient = _protocolRewardRecipient;
-        protocolRewards = _protocolRewards;
+        protocolRewardRecipient = protocolRewardRecipient_;
+        protocolRewards = protocolRewards_;
         poolManager = poolManager_;
-        airlock = _airlock;
+        airlock = airlock_;
     }
 
     /// @inheritdoc ICoin
@@ -258,7 +259,9 @@ abstract contract BaseCoin is ICoin, ContractVersionBase, ERC20PermitUpgradeable
             interfaceId == type(IERC7572).interfaceId ||
             interfaceId == type(IHasRewardsRecipients).interfaceId ||
             interfaceId == type(IHasPoolKey).interfaceId ||
-            type(IHasSwapPath).interfaceId == interfaceId;
+            interfaceId == type(IHasCoinType).interfaceId ||
+            interfaceId == type(IHasTotalSupplyForPositions).interfaceId ||
+            interfaceId == type(IHasSwapPath).interfaceId;
     }
 
     /// @dev Overrides ERC20's _update function to emit a superset `CoinTransfer` event

packages/coins/src/ContentCoin.sol

@@ -10,6 +10,8 @@ pragma solidity ^0.8.23;
 import {IPoolManager} from "@uniswap/v4-core/src/interfaces/IPoolManager.sol";
 import {BaseCoin} from "./BaseCoin.sol";
 import {CoinConstants} from "./libs/CoinConstants.sol";
+import {MarketConstants} from "./libs/MarketConstants.sol";
+import {IHasCoinType} from "./interfaces/ICoin.sol";
 
 /**
  * @title ContentCoin
@@ -42,4 +44,12 @@ contract ContentCoin is BaseCoin {
         // Transfer the market supply to the hook for liquidity
         _transfer(address(this), address(poolKey.hooks), balanceOf(address(this)));
     }
+
+    function totalSupplyForPositions() external pure override returns (uint256) {
+        return MarketConstants.CONTENT_COIN_MARKET_SUPPLY;
+    }
+
+    function coinType() external pure override returns (IHasCoinType.CoinType) {
+        return IHasCoinType.CoinType.Content;
+    }
 }

packages/coins/src/CreatorCoin.sol

@@ -12,18 +12,28 @@ import {CreatorCoinConstants} from "./libs/CreatorCoinConstants.sol";
 import {IHooks, PoolConfiguration, PoolKey, ICoin} from "./interfaces/ICoin.sol";
 import {IPoolManager} from "@uniswap/v4-core/src/interfaces/IPoolManager.sol";
 import {BaseCoin} from "./BaseCoin.sol";
+import {IHasCoinType} from "./interfaces/ICoin.sol";
+import {MarketConstants} from "./libs/MarketConstants.sol";
 
 contract CreatorCoin is ICreatorCoin, BaseCoin {
     uint256 public vestingStartTime;
     uint256 public vestingEndTime;
     uint256 public totalClaimed;
 
     constructor(
-        address _protocolRewardRecipient,
-        address _protocolRewards,
-        IPoolManager _poolManager,
-        address _airlock
-    ) BaseCoin(_protocolRewardRecipient, _protocolRewards, _poolManager, _airlock) initializer {}
+        address protocolRewardRecipient_,
+        address protocolRewards_,
+        IPoolManager poolManager_,
+        address airlock_
+    ) BaseCoin(protocolRewardRecipient_, protocolRewards_, poolManager_, airlock_) initializer {}
+
+    function totalSupplyForPositions() external pure override returns (uint256) {
+        return MarketConstants.CREATOR_COIN_MARKET_SUPPLY;
+    }
+
+    function coinType() external pure override returns (IHasCoinType.CoinType) {
+        return IHasCoinType.CoinType.Creator;
+    }
 
     function initialize(
         address payoutRecipient_,
@@ -39,7 +49,18 @@ contract CreatorCoin is ICreatorCoin, BaseCoin {
     ) public override(BaseCoin, ICoin) {
         require(currency_ == CreatorCoinConstants.CURRENCY, InvalidCurrency());
 
-        super.initialize(payoutRecipient_, owners_, tokenURI_, name_, symbol_, platformReferrer_, currency_, poolKey_, sqrtPriceX96, poolConfiguration_);
+        super.initialize({
+            payoutRecipient_: payoutRecipient_,
+            owners_: owners_,
+            tokenURI_: tokenURI_,
+            name_: name_,
+            symbol_: symbol_,
+            platformReferrer_: platformReferrer_,
+            currency_: currency_,
+            poolKey_: poolKey_,
+            sqrtPriceX96: sqrtPriceX96,
+            poolConfiguration_: poolConfiguration_
+        });
 
         vestingStartTime = block.timestamp;
         vestingEndTime = block.timestamp + CreatorCoinConstants.CREATOR_VESTING_DURATION;
@@ -50,7 +71,7 @@ contract CreatorCoin is ICreatorCoin, BaseCoin {
     function _handleInitialDistribution() internal override {
         _mint(address(this), CreatorCoinConstants.TOTAL_SUPPLY);
 
-        _transfer(address(this), address(poolKey.hooks), CreatorCoinConstants.MARKET_SUPPLY);
+        _transfer(address(this), address(poolKey.hooks), MarketConstants.CREATOR_COIN_MARKET_SUPPLY);
     }
 
     /// @notice Allows the creator payout recipient to claim vested tokens

packages/coins/src/ZoraFactoryImpl.sol

@@ -8,6 +8,7 @@
 pragma solidity ^0.8.23;
 
 import {Clones} from "@openzeppelin/contracts/proxy/Clones.sol";
+import {Strings} from "@openzeppelin/contracts/utils/Strings.sol";
 import {Ownable2StepUpgradeable} from "@openzeppelin/contracts-upgradeable/access/Ownable2StepUpgradeable.sol";
 import {ReentrancyGuardUpgradeable} from "@openzeppelin/contracts-upgradeable/utils/ReentrancyGuardUpgradeable.sol";
 import {UUPSUpgradeable} from "@openzeppelin/contracts-upgradeable/proxy/utils/UUPSUpgradeable.sol";
@@ -51,18 +52,16 @@ contract ZoraFactoryImpl is
     /// @notice The coin contract implementation address
     address public immutable coinV4Impl;
     address public immutable creatorCoinImpl;
-    address public immutable contentCoinHook;
-    address public immutable creatorCoinHook;
+    address public immutable hook;
     address public immutable zoraHookRegistry;
 
-    constructor(address _coinV4Impl, address _creatorCoinImpl, address _contentCoinHook, address _creatorCoinHook, address _zoraHookRegistry) {
+    constructor(address coinV4Impl_, address creatorCoinImpl_, address hook_, address zoraHookRegistry_) {
         _disableInitializers();
 
-        coinV4Impl = _coinV4Impl;
-        creatorCoinImpl = _creatorCoinImpl;
-        contentCoinHook = _contentCoinHook;
-        creatorCoinHook = _creatorCoinHook;
-        zoraHookRegistry = _zoraHookRegistry;
+        coinV4Impl = coinV4Impl_;
+        creatorCoinImpl = creatorCoinImpl_;
+        hook = hook_;
+        zoraHookRegistry = zoraHookRegistry_;
     }
 
     /// @notice Creates a new creator coin contract
@@ -99,7 +98,7 @@ contract ZoraFactoryImpl is
             poolConfig
         );
 
-        PoolKey memory poolKey = CoinSetup.buildPoolKey(address(creatorCoin), currency, isCoinToken0, IHooks(creatorCoinHook));
+        PoolKey memory poolKey = CoinSetup.buildPoolKey(address(creatorCoin), currency, isCoinToken0, IHooks(hook));
 
         ICreatorCoin(creatorCoin).initialize(payoutRecipient, owners, uri, name, symbol, platformReferrer, currency, poolKey, sqrtPriceX96, poolConfiguration);
 
@@ -157,17 +156,17 @@ contract ZoraFactoryImpl is
         string memory symbol,
         bytes memory poolConfig,
         address platformReferrer,
-        address hook,
+        address deployHook,
         bytes calldata hookData,
         bytes32 salt
     ) internal returns (address coin, bytes memory hookDataOut) {
         coin = address(_createAndInitializeCoin(payoutRecipient, owners, uri, name, symbol, poolConfig, platformReferrer, salt));
 
-        if (hook != address(0)) {
-            if (!IERC165(hook).supportsInterface(type(IHasAfterCoinDeploy).interfaceId)) {
+        if (deployHook != address(0)) {
+            if (!IERC165(deployHook).supportsInterface(type(IHasAfterCoinDeploy).interfaceId)) {
                 revert InvalidHook();
             }
-            hookDataOut = IHasAfterCoinDeploy(hook).afterCoinDeploy{value: msg.value}(msg.sender, ICoin(coin), hookData);
+            hookDataOut = IHasAfterCoinDeploy(deployHook).afterCoinDeploy{value: msg.value}(msg.sender, ICoin(coin), hookData);
         } else if (msg.value > 0) {
             // cannot send eth without a hook
             revert EthTransferInvalid();
@@ -205,11 +204,11 @@ contract ZoraFactoryImpl is
         string memory symbol,
         bytes memory poolConfig,
         address platformReferrer,
-        address hook,
+        address hook_,
         bytes calldata hookData
     ) public payable nonReentrant returns (address coin, bytes memory hookDataOut) {
         bytes32 salt = _randomSalt(payoutRecipient, uri, bytes32(0));
-        return _deployWithHook(payoutRecipient, owners, uri, name, symbol, poolConfig, platformReferrer, hook, hookData, salt);
+        return _deployWithHook(payoutRecipient, owners, uri, name, symbol, poolConfig, platformReferrer, hook_, hookData, salt);
     }
 
     /// @dev deprecated Use deploy() with poolConfig instead
@@ -222,8 +221,9 @@ contract ZoraFactoryImpl is
         address platformReferrer,
         address currency,
         // tickLower is no longer used
-        int24 /*tickLower*/,
-        uint256 orderSize
+        int24 /* tickLower */,
+        // orderSize is no longer used
+        uint256 /* orderSize */
     ) public payable nonReentrant returns (address, uint256) {
         bytes memory poolConfig = CoinConfigurationVersions.defaultConfig(currency);
         bytes32 salt = _randomSalt(payoutRecipient, uri, bytes32(0));
@@ -258,7 +258,7 @@ contract ZoraFactoryImpl is
         string memory symbol,
         address platformReferrer
     ) internal {
-        PoolKey memory poolKey = CoinSetup.buildPoolKey(address(coin), currency, isCoinToken0, IHooks(contentCoinHook));
+        PoolKey memory poolKey = CoinSetup.buildPoolKey(address(coin), currency, isCoinToken0, IHooks(hook));
 
         // Initialize coin with pre-configured pool
         coin.initialize(payoutRecipient, owners, uri, name, symbol, platformReferrer, currency, poolKey, sqrtPriceX96, poolConfiguration);
@@ -366,24 +366,30 @@ contract ZoraFactoryImpl is
         // try to get the existing contract name - if it reverts, the existing contract was an older version that didn't have the contract name
         // unfortunately we cannot use supportsInterface here because the existing implementation did not have that function
         try IHasContractName(newImpl).contractName() returns (string memory name) {
-            if (!_equals(name, contractName())) {
+            if (!Strings.equal(name, contractName())) {
                 revert UpgradeToMismatchedContractName(contractName(), name);
             }
         } catch {}
 
         // Auto-register the new hooks in the Zora hook registry
-        address[] memory hooks = new address[](2);
-        string[] memory tags = new string[](2);
+        address[] memory hooks = new address[](1);
+        string[] memory tags = new string[](1);
 
-        hooks[0] = IZoraFactory(newImpl).contentCoinHook();
-        hooks[1] = IZoraFactory(newImpl).creatorCoinHook();
-        tags[0] = "ContentCoinHook";
-        tags[1] = "CreatorCoinHook";
+        hooks[0] = IZoraFactory(newImpl).hook();
+        tags[0] = "CoinHook";
 
         IZoraHookRegistry(zoraHookRegistry).registerHooks(hooks, tags);
     }
 
-    function _equals(string memory a, string memory b) internal pure returns (bool) {
-        return (keccak256(bytes(a)) == keccak256(bytes(b)));
+    /// @notice The address of the latest creator coin hook
+    /// @dev Deprecated: use `hook` instead
+    function creatorCoinHook() external view returns (address) {
+        return hook;
+    }
+
+    /// @notice The address of the latest coin hook
+    /// @dev Deprecated: use `hook` instead
+    function contentCoinHook() external view returns (address) {
+        return hook;
     }
 }