@zoralabs/coins 2.2.1 → 2.3.1

package/package/wagmiGenerated.ts

@@ -1174,16 +1174,15 @@ export const baseCoinABI = [
   },
   { type: 'error', inputs: [], name: 'OnlyWeth' },
   { type: 'error', inputs: [], name: 'OwnerCannotBeAddressZero' },
-  { type: 'error', inputs: [], name: 'ReentrancyGuardReentrantCall' },
   { type: 'error', inputs: [], name: 'SlippageBoundsExceeded' },
   { type: 'error', inputs: [], name: 'UseRevokeOwnershipToRemoveSelf' },
 ] as const
 
 //////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
-// BuySupplyWithSwapRouterHook
+// BuySupplyWithV4SwapHook
 //////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
-export const buySupplyWithSwapRouterHookABI = [
+export const buySupplyWithV4SwapHookABI = [
   {
     type: 'constructor',
     inputs: [
@@ -1208,6 +1207,63 @@ export const buySupplyWithSwapRouterHookABI = [
     outputs: [{ name: '', internalType: 'bytes', type: 'bytes' }],
     stateMutability: 'payable',
   },
+  {
+    type: 'function',
+    inputs: [{ name: 'data', internalType: 'bytes', type: 'bytes' }],
+    name: 'decodeV4RouteData',
+    outputs: [
+      {
+        name: 'v4Route',
+        internalType: 'struct PoolKey[]',
+        type: 'tuple[]',
+        components: [
+          { name: 'currency0', internalType: 'Currency', type: 'address' },
+          { name: 'currency1', internalType: 'Currency', type: 'address' },
+          { name: 'fee', internalType: 'uint24', type: 'uint24' },
+          { name: 'tickSpacing', internalType: 'int24', type: 'int24' },
+          { name: 'hooks', internalType: 'contract IHooks', type: 'address' },
+        ],
+      },
+      { name: 'startAmount', internalType: 'uint256', type: 'uint256' },
+    ],
+    stateMutability: 'pure',
+  },
+  {
+    type: 'function',
+    inputs: [
+      {
+        name: 'params',
+        internalType: 'struct BuySupplyWithV4SwapHook.InitialSupplyParams',
+        type: 'tuple',
+        components: [
+          { name: 'buyRecipient', internalType: 'address', type: 'address' },
+          { name: 'v3Route', internalType: 'bytes', type: 'bytes' },
+          {
+            name: 'v4Route',
+            internalType: 'struct PoolKey[]',
+            type: 'tuple[]',
+            components: [
+              { name: 'currency0', internalType: 'Currency', type: 'address' },
+              { name: 'currency1', internalType: 'Currency', type: 'address' },
+              { name: 'fee', internalType: 'uint24', type: 'uint24' },
+              { name: 'tickSpacing', internalType: 'int24', type: 'int24' },
+              {
+                name: 'hooks',
+                internalType: 'contract IHooks',
+                type: 'address',
+              },
+            ],
+          },
+          { name: 'inputCurrency', internalType: 'address', type: 'address' },
+          { name: 'inputAmount', internalType: 'uint256', type: 'uint256' },
+          { name: 'minAmountOut', internalType: 'uint256', type: 'uint256' },
+        ],
+      },
+    ],
+    name: 'encodeBuySupplyWithV4SwapHookData',
+    outputs: [{ name: '', internalType: 'bytes', type: 'bytes' }],
+    stateMutability: 'pure',
+  },
   {
     type: 'function',
     inputs: [],
@@ -1217,6 +1273,15 @@ export const buySupplyWithSwapRouterHookABI = [
     ],
     stateMutability: 'view',
   },
+  {
+    type: 'function',
+    inputs: [],
+    name: 'poolManager',
+    outputs: [
+      { name: '', internalType: 'contract IPoolManager', type: 'address' },
+    ],
+    stateMutability: 'view',
+  },
   {
     type: 'function',
     inputs: [{ name: 'interfaceId', internalType: 'bytes4', type: 'bytes4' }],
@@ -1224,6 +1289,15 @@ export const buySupplyWithSwapRouterHookABI = [
     outputs: [{ name: '', internalType: 'bool', type: 'bool' }],
     stateMutability: 'pure',
   },
+  {
+    type: 'function',
+    inputs: [],
+    name: 'swapRouter',
+    outputs: [
+      { name: '', internalType: 'contract ISwapRouter', type: 'address' },
+    ],
+    stateMutability: 'view',
+  },
   {
     type: 'function',
     inputs: [{ name: 'data', internalType: 'bytes', type: 'bytes' }],
@@ -1231,6 +1305,58 @@ export const buySupplyWithSwapRouterHookABI = [
     outputs: [{ name: '', internalType: 'bytes', type: 'bytes' }],
     stateMutability: 'nonpayable',
   },
+  {
+    type: 'event',
+    anonymous: false,
+    inputs: [
+      { name: 'coin', internalType: 'address', type: 'address', indexed: true },
+      {
+        name: 'recipient',
+        internalType: 'address',
+        type: 'address',
+        indexed: true,
+      },
+      {
+        name: 'coinsPurchased',
+        internalType: 'uint256',
+        type: 'uint256',
+        indexed: true,
+      },
+      { name: 'v3Route', internalType: 'bytes', type: 'bytes', indexed: false },
+      {
+        name: 'v4Route',
+        internalType: 'struct PoolKey[]',
+        type: 'tuple[]',
+        components: [
+          { name: 'currency0', internalType: 'Currency', type: 'address' },
+          { name: 'currency1', internalType: 'Currency', type: 'address' },
+          { name: 'fee', internalType: 'uint24', type: 'uint24' },
+          { name: 'tickSpacing', internalType: 'int24', type: 'int24' },
+          { name: 'hooks', internalType: 'contract IHooks', type: 'address' },
+        ],
+        indexed: false,
+      },
+      {
+        name: 'inputCurrency',
+        internalType: 'address',
+        type: 'address',
+        indexed: false,
+      },
+      {
+        name: 'inputAmount',
+        internalType: 'uint256',
+        type: 'uint256',
+        indexed: false,
+      },
+      {
+        name: 'v4SwapInput',
+        internalType: 'uint256',
+        type: 'uint256',
+        indexed: false,
+      },
+    ],
+    name: 'BuyInitialSupply',
+  },
   {
     type: 'error',
     inputs: [{ name: 'target', internalType: 'address', type: 'address' }],
@@ -1242,20 +1368,17 @@ export const buySupplyWithSwapRouterHookABI = [
     name: 'AddressInsufficientBalance',
   },
   { type: 'error', inputs: [], name: 'AddressZero' },
+  { type: 'error', inputs: [], name: 'FailedInnerCall' },
+  { type: 'error', inputs: [], name: 'HookNotImplemented' },
   {
     type: 'error',
-    inputs: [{ name: 'balance', internalType: 'uint256', type: 'uint256' }],
-    name: 'CoinBalanceNot0',
-  },
-  {
-    type: 'error',
-    inputs: [{ name: 'balance', internalType: 'uint256', type: 'uint256' }],
-    name: 'CurrencyBalanceNot0',
+    inputs: [
+      { name: 'inputAmount', internalType: 'uint256', type: 'uint256' },
+      { name: 'availableAmount', internalType: 'uint256', type: 'uint256' },
+    ],
+    name: 'InsufficientInputCurrency',
   },
-  { type: 'error', inputs: [], name: 'Erc20NotReceived' },
-  { type: 'error', inputs: [], name: 'FailedInnerCall' },
-  { type: 'error', inputs: [], name: 'HookNotImplemented' },
-  { type: 'error', inputs: [], name: 'InvalidSwapRouterCall' },
+  { type: 'error', inputs: [], name: 'InsufficientOutputAmount' },
   { type: 'error', inputs: [], name: 'NotFactory' },
   { type: 'error', inputs: [], name: 'OnlyPoolManager' },
   {
@@ -1263,11 +1386,8 @@ export const buySupplyWithSwapRouterHookABI = [
     inputs: [{ name: 'token', internalType: 'address', type: 'address' }],
     name: 'SafeERC20FailedOperation',
   },
-  {
-    type: 'error',
-    inputs: [{ name: 'error', internalType: 'bytes', type: 'bytes' }],
-    name: 'SwapReverted',
-  },
+  { type: 'error', inputs: [], name: 'V3RouteCannotStartWithInputCurrency' },
+  { type: 'error', inputs: [], name: 'V3RouteDoesNotConnectToV4RouteStart' },
 ] as const
 
 //////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
@@ -2367,7 +2487,6 @@ export const contentCoinABI = [
   },
   { type: 'error', inputs: [], name: 'OnlyWeth' },
   { type: 'error', inputs: [], name: 'OwnerCannotBeAddressZero' },
-  { type: 'error', inputs: [], name: 'ReentrancyGuardReentrantCall' },
   { type: 'error', inputs: [], name: 'SlippageBoundsExceeded' },
   { type: 'error', inputs: [], name: 'UseRevokeOwnershipToRemoveSelf' },
 ] as const
@@ -3542,7 +3661,6 @@ export const creatorCoinABI = [
   },
   { type: 'error', inputs: [], name: 'OnlyWeth' },
   { type: 'error', inputs: [], name: 'OwnerCannotBeAddressZero' },
-  { type: 'error', inputs: [], name: 'ReentrancyGuardReentrantCall' },
   { type: 'error', inputs: [], name: 'SlippageBoundsExceeded' },
   { type: 'error', inputs: [], name: 'UseRevokeOwnershipToRemoveSelf' },
 ] as const
@@ -4414,6 +4532,27 @@ export const zoraFactoryImplABI = [
     outputs: [{ name: '', internalType: 'address', type: 'address' }],
     stateMutability: 'nonpayable',
   },
+  {
+    type: 'function',
+    inputs: [
+      { name: 'payoutRecipient', internalType: 'address', type: 'address' },
+      { name: 'owners', internalType: 'address[]', type: 'address[]' },
+      { name: 'uri', internalType: 'string', type: 'string' },
+      { name: 'name', internalType: 'string', type: 'string' },
+      { name: 'symbol', internalType: 'string', type: 'string' },
+      { name: 'poolConfig', internalType: 'bytes', type: 'bytes' },
+      { name: 'platformReferrer', internalType: 'address', type: 'address' },
+      { name: 'postDeployHook', internalType: 'address', type: 'address' },
+      { name: 'postDeployHookData', internalType: 'bytes', type: 'bytes' },
+      { name: 'coinSalt', internalType: 'bytes32', type: 'bytes32' },
+    ],
+    name: 'deployCreatorCoin',
+    outputs: [
+      { name: 'coin', internalType: 'address', type: 'address' },
+      { name: 'postDeployHookDataOut', internalType: 'bytes', type: 'bytes' },
+    ],
+    stateMutability: 'payable',
+  },
   {
     type: 'function',
     inputs: [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zoralabs/coins",
-  "version": "2.2.1",
+  "version": "2.3.1",
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",

package/script/DeployPostDeploymentHooks.s.sol

@@ -10,9 +10,7 @@ contract DeployHooks is CoinsDeployerBase {
 
         vm.startBroadcast();
 
-        // address buySupplyWithSwapRouterHook = address(deployBuySupplyWithSwapRouterHook(deployment));
-
-        // deployment.buySupplyWithSwapRouterHook = buySupplyWithSwapRouterHook;
+        deployment.buySupplyWithSwapRouterHook = address(deployBuySupplyWithV4SwapHook(deployment));
 
         vm.stopBroadcast();
 

package/script/TestBackingCoinSwap.s.sol

@@ -6,14 +6,12 @@ import {CoinsDeployerBase} from "../src/deployment/CoinsDeployerBase.sol";
 
 import {IZoraFactory} from "../src/interfaces/IZoraFactory.sol";
 import {CoinConfigurationVersions} from "../src/libs/CoinConfigurationVersions.sol";
-import {MarketConstants} from "../src/libs/MarketConstants.sol";
 import {UniV4SwapHelper} from "../src/libs/UniV4SwapHelper.sol";
 import {ContentCoin} from "../src/ContentCoin.sol";
 import {PoolKey} from "@uniswap/v4-core/src/types/PoolKey.sol";
 import {IUniversalRouter} from "@uniswap/universal-router/contracts/interfaces/IUniversalRouter.sol";
 import {IPermit2} from "permit2/src/interfaces/IPermit2.sol";
 import {MockERC20} from "../test/mocks/MockERC20.sol";
-import {MarketConstants} from "../src/libs/MarketConstants.sol";
 import {Currency} from "@uniswap/v4-core/src/types/Currency.sol";
 import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
 import {ICoin} from "../src/interfaces/ICoin.sol";

package/script/TestV4Swap.s.sol

@@ -6,14 +6,12 @@ import {CoinsDeployerBase} from "../src/deployment/CoinsDeployerBase.sol";
 
 import {IZoraFactory} from "../src/interfaces/IZoraFactory.sol";
 import {CoinConfigurationVersions} from "../src/libs/CoinConfigurationVersions.sol";
-import {MarketConstants} from "../src/libs/MarketConstants.sol";
 import {UniV4SwapHelper} from "../src/libs/UniV4SwapHelper.sol";
 import {ContentCoin} from "../src/ContentCoin.sol";
 import {PoolKey} from "@uniswap/v4-core/src/types/PoolKey.sol";
 import {IUniversalRouter} from "@uniswap/universal-router/contracts/interfaces/IUniversalRouter.sol";
 import {IPermit2} from "permit2/src/interfaces/IPermit2.sol";
 import {MockERC20} from "../test/mocks/MockERC20.sol";
-import {MarketConstants} from "../src/libs/MarketConstants.sol";
 import {Currency} from "@uniswap/v4-core/src/types/Currency.sol";
 import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
 import {ICoin} from "../src/interfaces/ICoin.sol";

package/src/BaseCoin.sol

@@ -32,7 +32,6 @@ import {CoinCommon} from "./libs/CoinCommon.sol";
 import {Address} from "@openzeppelin/contracts/utils/Address.sol";
 import {ERC20PermitUpgradeable} from "@openzeppelin/contracts-upgradeable/token/ERC20/extensions/ERC20PermitUpgradeable.sol";
 import {ERC165Upgradeable} from "@openzeppelin/contracts-upgradeable/utils/introspection/ERC165Upgradeable.sol";
-import {ReentrancyGuardUpgradeable} from "@openzeppelin/contracts-upgradeable/utils/ReentrancyGuardUpgradeable.sol";
 import {SafeERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
 import {ContractVersionBase} from "./version/ContractVersionBase.sol";
 import {MultiOwnable} from "./utils/MultiOwnable.sol";
@@ -40,7 +39,6 @@ import {FullMath} from "./utils/uniswap/FullMath.sol";
 import {TickMath} from "./utils/uniswap/TickMath.sol";
 import {LiquidityAmounts} from "./utils/uniswap/LiquidityAmounts.sol";
 import {CoinConstants} from "./libs/CoinConstants.sol";
-import {MarketConstants} from "./libs/MarketConstants.sol";
 import {LpPosition} from "./types/LpPosition.sol";
 import {PoolState} from "./types/PoolState.sol";
 
@@ -54,7 +52,7 @@ import {PoolState} from "./types/PoolState.sol";
     \$$$$$$  | $$$$$$  |$$$$$$\ $$ | \$$ |
      \______/  \______/ \______|\__|  \__|
 */
-abstract contract BaseCoin is ICoin, ContractVersionBase, ERC20PermitUpgradeable, MultiOwnable, ReentrancyGuardUpgradeable, ERC165Upgradeable {
+abstract contract BaseCoin is ICoin, ContractVersionBase, ERC20PermitUpgradeable, MultiOwnable, ERC165Upgradeable {
     using SafeERC20 for IERC20;
 
     /// @notice The address of the protocol rewards contract
@@ -168,7 +166,6 @@ abstract contract BaseCoin is ICoin, ContractVersionBase, ERC20PermitUpgradeable
         __ERC20Permit_init("");
 
         __MultiOwnable_init(owners_);
-        __ReentrancyGuard_init();
 
         // Set mutable state
         _setPayoutRecipient(payoutRecipient_);
@@ -181,14 +178,9 @@ abstract contract BaseCoin is ICoin, ContractVersionBase, ERC20PermitUpgradeable
         _handleInitialDistribution();
     }
 
-    /// @dev The initial mint and distribution of the coin supply.
-    function _handleInitialDistribution() internal virtual {
-        // Mint the total supply to the coin contract
-        _mint(address(this), CoinConstants.MAX_TOTAL_SUPPLY);
-
-        // Distribute the creator launch reward to the payout recipient
-        _transfer(address(this), payoutRecipient, CoinConstants.CREATOR_LAUNCH_REWARD);
-    }
+    /// @notice The initial mint and distribution of the coin supply.
+    /// @dev This function must be overridden by the child contract.
+    function _handleInitialDistribution() internal virtual;
 
     /// @notice Returns the name of the token for EIP712 domain.
     /// @notice This can change when the user changes the "name" of the token.

package/src/ContentCoin.sol

@@ -10,12 +10,11 @@ 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
- * @notice Content coin implementation that uses creator coins as backing currency
+ * @notice Content coin implementation that typically uses creator coins as backing currency, but can be set to any currency as the backing currency
  * @dev Inherits from BaseCoin and implements content-specific distribution logic
  */
 contract ContentCoin is BaseCoin {
@@ -39,14 +38,14 @@ contract ContentCoin is BaseCoin {
         _mint(address(this), CoinConstants.MAX_TOTAL_SUPPLY);
 
         // Distribute the creator launch reward to the payout recipient
-        _transfer(address(this), payoutRecipient, CoinConstants.CREATOR_LAUNCH_REWARD);
+        _transfer(address(this), payoutRecipient, CoinConstants.CONTENT_COIN_INITIAL_CREATOR_SUPPLY);
 
         // 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;
+        return CoinConstants.CONTENT_COIN_MARKET_SUPPLY;
     }
 
     function coinType() external pure override returns (IHasCoinType.CoinType) {

package/src/CreatorCoin.sol

@@ -8,12 +8,11 @@
 pragma solidity ^0.8.28;
 
 import {ICreatorCoin} from "./interfaces/ICreatorCoin.sol";
-import {CreatorCoinConstants} from "./libs/CreatorCoinConstants.sol";
+import {CoinConstants} from "./libs/CoinConstants.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;
@@ -28,7 +27,7 @@ contract CreatorCoin is ICreatorCoin, BaseCoin {
     ) BaseCoin(protocolRewardRecipient_, protocolRewards_, poolManager_, airlock_) initializer {}
 
     function totalSupplyForPositions() external pure override returns (uint256) {
-        return MarketConstants.CREATOR_COIN_MARKET_SUPPLY;
+        return CoinConstants.CREATOR_COIN_MARKET_SUPPLY;
     }
 
     function coinType() external pure override returns (IHasCoinType.CoinType) {
@@ -47,7 +46,7 @@ contract CreatorCoin is ICreatorCoin, BaseCoin {
         uint160 sqrtPriceX96,
         PoolConfiguration memory poolConfiguration_
     ) public override(BaseCoin, ICoin) {
-        require(currency_ == CreatorCoinConstants.CURRENCY, InvalidCurrency());
+        require(currency_ == CoinConstants.CREATOR_COIN_CURRENCY, InvalidCurrency());
 
         super.initialize({
             payoutRecipient_: payoutRecipient_,
@@ -63,19 +62,18 @@ contract CreatorCoin is ICreatorCoin, BaseCoin {
         });
 
         vestingStartTime = block.timestamp;
-        vestingEndTime = block.timestamp + CreatorCoinConstants.CREATOR_VESTING_DURATION;
+        vestingEndTime = block.timestamp + CoinConstants.CREATOR_VESTING_DURATION;
     }
 
     /// @dev The initial mint and distribution of the coin supply.
     ///      Implements creator coin specific distribution: 500M to liquidity pool, 500M vested to creator.
     function _handleInitialDistribution() internal override {
-        _mint(address(this), CreatorCoinConstants.TOTAL_SUPPLY);
+        _mint(address(this), CoinConstants.TOTAL_SUPPLY);
 
-        _transfer(address(this), address(poolKey.hooks), MarketConstants.CREATOR_COIN_MARKET_SUPPLY);
+        _transfer(address(this), address(poolKey.hooks), CoinConstants.CREATOR_COIN_MARKET_SUPPLY);
     }
 
     /// @notice Allows the creator payout recipient to claim vested tokens
-    /// @dev Optimized for frequent calls from Uniswap V4 hooks
     /// @return claimAmount The amount of tokens claimed
     function claimVesting() external returns (uint256) {
         uint256 claimAmount = getClaimableAmount();
@@ -114,13 +112,13 @@ contract CreatorCoin is ICreatorCoin, BaseCoin {
 
         // After vesting ends - fully vested
         if (timestamp >= vestingEndTime) {
-            return CreatorCoinConstants.CREATOR_VESTING_SUPPLY;
+            return CoinConstants.CREATOR_COIN_CREATOR_VESTING_SUPPLY;
         }
 
         // Linear vesting: (elapsed_time / total_duration) * total_amount
         uint256 elapsedTime = timestamp - vestingStartTime;
 
         // Multiply first to avoid precision loss
-        return (CreatorCoinConstants.CREATOR_VESTING_SUPPLY * elapsedTime) / CreatorCoinConstants.CREATOR_VESTING_DURATION;
+        return (CoinConstants.CREATOR_COIN_CREATOR_VESTING_SUPPLY * elapsedTime) / CoinConstants.CREATOR_VESTING_DURATION;
     }
 }