@zoralabs/coins 2.0.0 → 2.1.1

package/src/hooks/BaseZoraV4CoinHook.sol

@@ -16,11 +16,11 @@ import {Currency} from "@uniswap/v4-core/src/types/Currency.sol";
 import {SwapParams} from "@uniswap/v4-core/src/types/PoolOperation.sol";
 import {IZoraV4CoinHook} from "../interfaces/IZoraV4CoinHook.sol";
 import {IMsgSender} from "../interfaces/IMsgSender.sol";
-import {IHasSwapPath} from "../interfaces/ICoinV4.sol";
+import {IHasSwapPath} from "../interfaces/ICoin.sol";
 import {LpPosition} from "../types/LpPosition.sol";
 import {V4Liquidity} from "../libs/V4Liquidity.sol";
 import {CoinRewardsV4} from "../libs/CoinRewardsV4.sol";
-import {ICoinV4} from "../interfaces/ICoinV4.sol";
+import {ICoin} from "../interfaces/ICoin.sol";
 import {IDeployedCoinVersionLookup} from "../interfaces/IDeployedCoinVersionLookup.sol";
 import {CoinCommon} from "../libs/CoinCommon.sol";
 import {CoinDopplerMultiCurve} from "../libs/CoinDopplerMultiCurve.sol";
@@ -140,7 +140,7 @@ abstract contract BaseZoraV4CoinHook is BaseHook, ContractVersionBase, IZoraV4Co
     /// @param coin The coin address.
     /// @param key The pool key for the coin.
     /// @return positions The contract-created liquidity positions the positions for the coin's pool.
-    function _generatePositions(ICoinV4 coin, PoolKey memory key) internal view returns (LpPosition[] memory positions) {
+    function _generatePositions(ICoin coin, PoolKey memory key) internal view returns (LpPosition[] memory positions) {
         bool isCoinToken0 = Currency.unwrap(key.currency0) == address(coin);
 
         positions = CoinDopplerMultiCurve.calculatePositions(isCoinToken0, coin.getPoolConfiguration(), totalSupplyForPositions);
@@ -163,7 +163,7 @@ abstract contract BaseZoraV4CoinHook is BaseHook, ContractVersionBase, IZoraV4Co
             revert NotACoin(coin);
         }
 
-        LpPosition[] memory positions = _generatePositions(ICoinV4(coin), key);
+        LpPosition[] memory positions = _generatePositions(ICoin(coin), key);
 
         _initializeForPositions(key, coin, positions);
 
@@ -312,7 +312,7 @@ abstract contract BaseZoraV4CoinHook is BaseHook, ContractVersionBase, IZoraV4Co
             payoutSwapPath
         );
 
-        _distributeMarketRewards(payoutCurrency, payoutAmount, ICoinV4(coin), CoinRewardsV4.getTradeReferral(hookData));
+        _distributeMarketRewards(payoutCurrency, payoutAmount, ICoin(coin), CoinRewardsV4.getTradeReferral(hookData));
 
         {
             (address swapper, bool isTrustedSwapSenderAddress) = _getOriginalMsgSender(sender);

package/src/hooks/ContentCoinHook.sol

@@ -9,7 +9,7 @@ pragma solidity ^0.8.28;
 
 import {IPoolManager, IDeployedCoinVersionLookup, IHasRewardsRecipients, Currency, BaseZoraV4CoinHook} from "./BaseZoraV4CoinHook.sol";
 import {CoinRewardsV4} from "../libs/CoinRewardsV4.sol";
-import {MarketConstants} from "../libs/MarketConstants.sol";
+import {CoinConstants} from "../libs/CoinConstants.sol";
 import {IHooksUpgradeGate} from "../interfaces/IHooksUpgradeGate.sol";
 
 contract ContentCoinHook is BaseZoraV4CoinHook {
@@ -18,7 +18,7 @@ contract ContentCoinHook is BaseZoraV4CoinHook {
         IDeployedCoinVersionLookup coinVersionLookup_,
         address[] memory trustedMessageSenders_,
         IHooksUpgradeGate upgradeGate
-    ) BaseZoraV4CoinHook(poolManager_, coinVersionLookup_, trustedMessageSenders_, upgradeGate, MarketConstants.POOL_LAUNCH_SUPPLY) {}
+    ) BaseZoraV4CoinHook(poolManager_, coinVersionLookup_, trustedMessageSenders_, upgradeGate, CoinConstants.POOL_LAUNCH_SUPPLY) {}
 
     /// @dev Override for market reward distribution
     function _distributeMarketRewards(Currency currency, uint128 fees, IHasRewardsRecipients coin, address tradeReferrer) internal override {

package/src/hooks/deployment/BuySupplyWithSwapRouterHook.sol

@@ -12,9 +12,8 @@ import {ICoin} from "../../interfaces/ICoin.sol";
 import {IZoraFactory} from "../../interfaces/IZoraFactory.sol";
 import {ISwapRouter} from "../../interfaces/ISwapRouter.sol";
 import {IWETH} from "../../interfaces/IWETH.sol";
-import {Coin} from "../../Coin.sol";
 import {ICoinV3} from "../../interfaces/ICoinV3.sol";
-import {ICoinV4} from "../../interfaces/ICoinV4.sol";
+import {ICoin} from "../../interfaces/ICoin.sol";
 import {CoinConfigurationVersions} from "../../libs/CoinConfigurationVersions.sol";
 
 /// @title BuySupplyWithSwapRouter
@@ -84,7 +83,7 @@ contract BuySupplyWithSwapRouterHook is BaseCoinDeployHook {
         IERC20(coin.currency()).approve(address(coin), amountCurrency);
 
         if (CoinConfigurationVersions.isV4(factory.getVersionForDeployedCoin(address(coin)))) {
-            coinsPurchased = _executeV4Buy(buyRecipient, ICoinV4(payable(address(coin))), amountCurrency);
+            coinsPurchased = _executeV4Buy(buyRecipient, ICoin(payable(address(coin))), amountCurrency);
         } else {
             coinsPurchased = _executeV3Buy(buyRecipient, ICoinV3(payable(address(coin))), amountCurrency);
         }
@@ -101,7 +100,7 @@ contract BuySupplyWithSwapRouterHook is BaseCoinDeployHook {
         (, coinsPurchased) = ICoinV3(payable(address(coin))).buy(buyRecipient, amountCurrency, 0, 0, address(0));
     }
 
-    function _executeV4Buy(address buyRecipient, ICoinV4 coin, uint256 amountCurrency) internal returns (uint256 coinsPurchased) {
+    function _executeV4Buy(address buyRecipient, ICoin coin, uint256 amountCurrency) internal returns (uint256 coinsPurchased) {
         bytes memory data = abi.encode(buyRecipient, coin, amountCurrency);
 
         bytes memory result = poolManager.unlock(data);
@@ -115,7 +114,7 @@ contract BuySupplyWithSwapRouterHook is BaseCoinDeployHook {
     function unlockCallback(bytes calldata data) external returns (bytes memory) {
         require(msg.sender == address(poolManager), OnlyPoolManager());
 
-        (address buyRecipient, ICoinV4 coin, uint256 amountCurrency) = abi.decode(data, (address, ICoinV4, uint256));
+        (address buyRecipient, ICoin coin, uint256 amountCurrency) = abi.decode(data, (address, ICoin, uint256));
 
         bool zeroForOne = coin.currency() == Currency.unwrap(coin.getPoolKey().currency0);
 

package/src/interfaces/ICoin.sol

@@ -7,6 +7,10 @@ import {IDopplerErrors} from "./IDopplerErrors.sol";
 import {PoolKey} from "@uniswap/v4-core/src/interfaces/IPoolManager.sol";
 import {PoolConfiguration} from "../types/PoolConfiguration.sol";
 import {IHasRewardsRecipients} from "./IHasRewardsRecipients.sol";
+import {IHooks} from "@uniswap/v4-core/src/interfaces/IHooks.sol";
+import {PathKey} from "@uniswap/v4-periphery/src/libraries/PathKey.sol";
+import {Currency} from "@uniswap/v4-core/src/types/Currency.sol";
+import {IDeployedCoinVersionLookup} from "./IDeployedCoinVersionLookup.sol";
 
 struct PoolConfigurationV4 {
     uint8 version;
@@ -22,7 +26,31 @@ struct PoolKeyStruct {
     address hooks;
 }
 
-interface ICoin is IERC165, IERC7572, IDopplerErrors, IHasRewardsRecipients {
+/// @notice Returns the pool key for the coin
+interface IHasPoolKey {
+    /// @notice Returns the Uniswap V4 pool key associated with this coin
+    /// @return The PoolKey struct containing pool identification parameters
+    function getPoolKey() external view returns (PoolKey memory);
+}
+
+/// @notice Returns the pool configuration for the coin
+interface IHasSwapPath {
+    /// @notice Struct containing the swap path configuration for converting fees to payout currency
+    /// @param path Array of PathKey structs defining the multi-hop swap route
+    /// @param currencyIn The input currency to start the swap path from
+    struct PayoutSwapPath {
+        PathKey[] path;
+        Currency currencyIn;
+    }
+
+    /// @notice Returns the swap path configuration for converting this coin to its final payout currency
+    /// @dev This enables multi-hop swaps through intermediate currencies to reach the target payout token
+    /// @param coinVersionLookup Contract for looking up deployed coin versions to build recursive paths
+    /// @return PayoutSwapPath struct containing the complete swap route configuration
+    function getPayoutSwapPath(IDeployedCoinVersionLookup coinVersionLookup) external view returns (PayoutSwapPath memory);
+}
+
+interface ICoin is IERC165, IERC7572, IDopplerErrors, IHasRewardsRecipients, IHasPoolKey, IHasSwapPath {
     /// @notice Thrown when the name is required for the coin
     error NameIsRequired();
 
@@ -216,4 +244,42 @@ interface ICoin is IERC165, IERC7572, IDopplerErrors, IHasRewardsRecipients {
     /// @param newName The new coin name
     /// @param newSymbol The new coin symbol
     function setNameAndSymbol(string memory newName, string memory newSymbol) external;
+
+    /// @notice Returns the pool configuration settings for this coin's Uniswap V4 pool
+    /// @return PoolConfiguration struct containing pool-specific settings and parameters
+    function getPoolConfiguration() external view returns (PoolConfiguration memory);
+
+    /// @notice Emitted when a hook is upgraded
+    /// @param fromPoolKey The pool key being upgraded
+    /// @param toPoolKey The new pool key returned from the destination hook
+    event LiquidityMigrated(PoolKey fromPoolKey, bytes32 fromPoolKeyHash, PoolKey toPoolKey, bytes32 toPoolKeyHash);
+
+    /// @notice Returns the hooks contract used by this coin's Uniswap V4 pool
+    /// @return The IHooks contract interface that handles pool lifecycle events
+    function hooks() external view returns (IHooks);
+
+    /// @notice Initializes the coin
+    /// @dev Called by the factory contract when the contract is deployed.
+    /// @param payoutRecipient_ The address of the payout recipient. Can be updated by the owner. Cannot be 0 address.
+    /// @param owners_ The addresses of the owners. All owners have the same full admin access. Cannot be 0 address.
+    /// @param tokenURI_ The URI of the token. Can be updated by the owner.
+    /// @param name_ The name of the token. Cannot be updated.
+    /// @param symbol_ The symbol of the token. Cannot be updated.
+    /// @param platformReferrer_ The address of the platform referrer. Cannot be updated.
+    /// @param currency_ The currency of the coin. Cannot be updated. Can be the zero address for ETH.
+    /// @param poolKey_ The pool key for the coin. Derived in the factory.
+    /// @param sqrtPriceX96 The initial sqrt price for the pool
+    /// @param poolConfiguration_ The configuration for the pool
+    function initialize(
+        address payoutRecipient_,
+        address[] memory owners_,
+        string memory tokenURI_,
+        string memory name_,
+        string memory symbol_,
+        address platformReferrer_,
+        address currency_,
+        PoolKey memory poolKey_,
+        uint160 sqrtPriceX96,
+        PoolConfiguration memory poolConfiguration_
+    ) external;
 }

package/src/interfaces/ICreatorCoin.sol

@@ -1,9 +1,9 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.23;
 
-import {ICoinV4} from "./ICoinV4.sol";
+import {ICoin} from "./ICoin.sol";
 
-interface ICreatorCoin is ICoinV4 {
+interface ICreatorCoin is ICoin {
     /// @notice Emitted when creator vesting tokens are claimed
     /// @param recipient The address that received the vested tokens
     /// @param claimAmount The amount of tokens claimed in this transaction

package/src/interfaces/IZoraFactory.sol

@@ -80,9 +80,6 @@ interface IZoraFactory is IDeployedCoinVersionLookup {
         string version
     );
 
-    /// @notice Thrown when the amount of ERC20 tokens transferred does not match the expected amount
-    error ERC20TransferAmountMismatch();
-
     /// @notice Thrown when ETH is sent with a transaction but the currency is not WETH
     error EthTransferInvalid();
 
@@ -166,8 +163,6 @@ interface IZoraFactory is IDeployedCoinVersionLookup {
         bytes calldata hookData
     ) external payable returns (address coin, bytes memory hookDataOut);
 
-    function coinImpl() external view returns (address);
-
     function implementation() external view returns (address);
 
     /// @notice Thrown when the hook is invalid

package/src/libs/CoinConfigurationVersions.sol

@@ -30,33 +30,6 @@ library CoinConfigurationVersions {
         (version, currency) = abi.decode(poolConfig, (uint8, address));
     }
 
-    function decodeDopplerUniV3(
-        bytes memory poolConfig
-    )
-        internal
-        pure
-        returns (uint8 version, address currency, int24 tickLower_, int24 tickUpper_, uint16 numDiscoveryPositions_, uint256 maxDiscoverySupplyShare_)
-    {
-        (version, currency, tickLower_, tickUpper_, numDiscoveryPositions_, maxDiscoverySupplyShare_) = abi.decode(
-            poolConfig,
-            (uint8, address, int24, int24, uint16, uint256)
-        );
-    }
-
-    function encodeDopplerUniV3(
-        address currency,
-        int24 tickLower_,
-        int24 tickUpper_,
-        uint16 numDiscoveryPositions_,
-        uint256 maxDiscoverySupplyShare_
-    ) internal pure returns (bytes memory) {
-        return abi.encode(DOPPLER_UNI_V3_POOL_VERSION, currency, tickLower_, tickUpper_, numDiscoveryPositions_, maxDiscoverySupplyShare_);
-    }
-
-    function decodeLegacy(bytes memory poolConfig) internal pure returns (uint8 version, address currency, int24 tickLower_) {
-        (version, currency, tickLower_) = abi.decode(poolConfig, (uint8, address, int24));
-    }
-
     function decodeVanillaUniV4(bytes memory poolConfig) internal pure returns (uint8 version, address currency, int24 tickLower_) {
         (version, currency, tickLower_) = abi.decode(poolConfig, (uint8, address, int24));
     }
@@ -91,17 +64,6 @@ library CoinConfigurationVersions {
         );
     }
 
-    function defaultDopplerUniV3(address currency) internal pure returns (bytes memory) {
-        return
-            encodeDopplerUniV3(
-                currency,
-                CoinConstants.DEFAULT_DISCOVERY_TICK_LOWER,
-                CoinConstants.DEFAULT_DISCOVERY_TICK_UPPER,
-                CoinConstants.DEFAULT_NUM_DISCOVERY_POSITIONS,
-                CoinConstants.DEFAULT_DISCOVERY_SUPPLY_SHARE
-            );
-    }
-
     function defaultDopplerMultiCurveUniV4(address currency) internal pure returns (bytes memory) {
         int24[] memory tickLower = new int24[](2);
         int24[] memory tickUpper = new int24[](2);
@@ -125,6 +87,6 @@ library CoinConfigurationVersions {
     }
 
     function defaultConfig(address currency) internal pure returns (bytes memory) {
-        return defaultDopplerUniV3(currency);
+        return defaultDopplerMultiCurveUniV4(currency);
     }
 }

package/src/libs/CoinRewardsV4.sol

@@ -26,7 +26,7 @@ import {LiquidityAmounts} from "../utils/uniswap/LiquidityAmounts.sol";
 import {IHasRewardsRecipients} from "../interfaces/IHasRewardsRecipients.sol";
 import {ICoin} from "../interfaces/ICoin.sol";
 import {IZoraV4CoinHook} from "../interfaces/IZoraV4CoinHook.sol";
-import {IHasSwapPath} from "../interfaces/ICoinV4.sol";
+import {IHasSwapPath} from "../interfaces/ICoin.sol";
 import {V4Liquidity} from "./V4Liquidity.sol";
 import {UniV4SwapToCurrency} from "./UniV4SwapToCurrency.sol";
 
@@ -53,7 +53,7 @@ library CoinRewardsV4 {
     uint256 public constant LP_REWARD_BPS = 3333;
 
     function getTradeReferral(bytes calldata hookData) internal pure returns (address) {
-        return hookData.length > 0 ? abi.decode(hookData, (address)) : address(0);
+        return hookData.length >= 20 ? abi.decode(hookData, (address)) : address(0);
     }
 
     /// @dev Converts collected fees from LP positions into target payout currency, and transfers to hook contract, so

package/src/libs/CoinSetup.sol

@@ -19,7 +19,6 @@ import {IPositionManager} from "@uniswap/v4-periphery/src/interfaces/IPositionMa
 import {MarketConstants} from "./MarketConstants.sol";
 import {LpPosition} from "../types/LpPosition.sol";
 import {CoinDopplerMultiCurve, PoolConfiguration} from "./CoinDopplerMultiCurve.sol";
-import {CoinDopplerUniV3} from "./CoinDopplerUniV3.sol";
 
 library CoinSetup {
     function generatePoolConfig(
@@ -52,9 +51,7 @@ library CoinSetup {
         bytes memory poolConfig_,
         bool isCoinToken0
     ) internal pure returns (uint160 sqrtPriceX96, PoolConfiguration memory poolConfiguration) {
-        if (version == CoinConfigurationVersions.DOPPLER_UNI_V3_POOL_VERSION) {
-            (sqrtPriceX96, poolConfiguration) = CoinDopplerUniV3.setupPool(isCoinToken0, poolConfig_);
-        } else if (version == CoinConfigurationVersions.DOPPLER_MULTICURVE_UNI_V4_POOL_VERSION) {
+        if (version == CoinConfigurationVersions.DOPPLER_MULTICURVE_UNI_V4_POOL_VERSION) {
             (sqrtPriceX96, poolConfiguration) = CoinDopplerMultiCurve.setupPool(isCoinToken0, poolConfig_);
         } else {
             revert ICoin.InvalidPoolVersion();

package/src/libs/MarketConstants.sol

@@ -2,10 +2,6 @@
 pragma solidity ^0.8.23;
 
 library MarketConstants {
-    /// @notice The number of coins allocated to the liquidity pool
-    /// @dev 990 million coins
-    uint256 internal constant POOL_LAUNCH_SUPPLY = 990_000_000e18;
-
     /// @dev Constant used to increase precision during calculations
     uint256 constant WAD = 1e18;
 

package/src/libs/UniV4SwapHelper.sol

@@ -16,7 +16,7 @@ import {IPermit2} from "permit2/src/interfaces/IPermit2.sol";
 import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
 import {Currency} from "@uniswap/v4-core/src/types/Currency.sol";
 import {ISwapPathRouter} from "../interfaces/ISwapPathRouter.sol";
-import {IHasPoolKey} from "../interfaces/ICoinV4.sol";
+import {IHasPoolKey} from "../interfaces/ICoin.sol";
 import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
 import {IPoolManager} from "@uniswap/v4-core/src/interfaces/IPoolManager.sol";
 import {PathKey} from "@uniswap/v4-periphery/src/libraries/PathKey.sol";

package/src/libs/UniV4SwapToCurrency.sol

@@ -9,12 +9,12 @@ pragma solidity ^0.8.23;
 
 import {Currency} from "@uniswap/v4-core/src/types/Currency.sol";
 import {ISwapPathRouter} from "../interfaces/ISwapPathRouter.sol";
-import {IHasPoolKey} from "../interfaces/ICoinV4.sol";
+import {IHasPoolKey} from "../interfaces/ICoin.sol";
 import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
 import {IPoolManager, PoolKey} from "@uniswap/v4-core/src/interfaces/IPoolManager.sol";
 import {SwapParams} from "@uniswap/v4-core/src/types/PoolOperation.sol";
 import {BalanceDelta, BalanceDeltaLibrary} from "@uniswap/v4-core/src/types/BalanceDelta.sol";
-import {IHasSwapPath} from "../interfaces/ICoinV4.sol";
+import {IHasSwapPath} from "../interfaces/ICoin.sol";
 import {TickMath} from "@uniswap/v4-core/src/libraries/TickMath.sol";
 import {PathKey} from "@uniswap/v4-periphery/src/libraries/PathKey.sol";
 import {IDeployedCoinVersionLookup} from "../interfaces/IDeployedCoinVersionLookup.sol";

package/src/libs/V4Liquidity.sol

@@ -22,7 +22,7 @@ import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
 import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
 import {SwapParams} from "@uniswap/v4-core/src/types/PoolOperation.sol";
 import {IHasRewardsRecipients} from "../interfaces/ICoin.sol";
-import {IHasSwapPath} from "../interfaces/ICoinV4.sol";
+import {IHasSwapPath} from "../interfaces/ICoin.sol";
 import {UniV4SwapToCurrency} from "./UniV4SwapToCurrency.sol";
 import {PathKey} from "@uniswap/v4-periphery/src/libraries/PathKey.sol";
 import {Position} from "@uniswap/v4-core/src/libraries/Position.sol";

package/src/version/ContractVersionBase.sol

@@ -9,6 +9,6 @@ import {IVersionedContract} from "@zoralabs/shared-contracts/interfaces/IVersion
 contract ContractVersionBase is IVersionedContract {
     /// @notice The version of the contract
     function contractVersion() external pure override returns (string memory) {
-        return "2.0.0";
+        return "2.1.1";
     }
 }