@zoralabs/coins 2.1.2 → 2.3.0

package/.turbo/turbo-build$colon$js.log

@@ -0,0 +1,152 @@
+
+> @zoralabs/coins@2.3.0 build:js /home/runner/work/zora-protocol-private/zora-protocol-private/packages/coins
+> pnpm run wagmi:generate && pnpm run copy-abis && pnpm run prettier:write && tsup
+
+
+> @zoralabs/coins@2.3.0 wagmi:generate /home/runner/work/zora-protocol-private/zora-protocol-private/packages/coins
+> pnpm run build:contracts:minimal && wagmi generate && pnpm exec rename-generated-abi-casing ./package/wagmiGenerated.ts
+
+
+> @zoralabs/coins@2.3.0 build:contracts:minimal /home/runner/work/zora-protocol-private/zora-protocol-private/packages/coins
+> forge build --skip test --skip script --no-metadata
+
+Compiling 210 files with Solc 0.8.28
+Solc 0.8.28 finished in 76.74s
+Compiler run successful!
+- Validating plugins
+✔ Validating plugins
+- Resolving contracts
+✔ Resolving contracts
+- Running plugins
+✔ Running plugins
+- Writing to package/wagmiGenerated.ts
+✔ Writing to package/wagmiGenerated.ts
+🔄 Processing 1 file(s) to replace 'Abi' with 'ABI'...
+📝 Processing ./package/wagmiGenerated.ts...
+✅ Updated ./package/wagmiGenerated.ts (10 replacements)
+✨ All files processed successfully!
+
+> @zoralabs/coins@2.3.0 copy-abis /home/runner/work/zora-protocol-private/zora-protocol-private/packages/coins
+> pnpm exec bundle-abis
+
+
+> @zoralabs/coins@2.3.0 prettier:write /home/runner/work/zora-protocol-private/zora-protocol-private/packages/coins
+> prettier --write 'src/**/*.sol' 'test/**/*.sol' 'script/**/*.sol'
+
+src/BaseCoin.sol 805ms (unchanged)
+src/ContentCoin.sol 67ms (unchanged)
+src/CreatorCoin.sol 99ms (unchanged)
+src/deployment/CoinsDeployerBase.sol 324ms (unchanged)
+src/hook-registry/ZoraHookRegistry.sol 136ms (unchanged)
+src/hooks/deployment/BaseCoinDeployHook.sol 28ms (unchanged)
+src/hooks/deployment/BuySupplyWithSwapRouterHook.sol 256ms (unchanged)
+src/hooks/HookUpgradeGate.sol 27ms (unchanged)
+src/hooks/ZoraV4CoinHook.sol 250ms (unchanged)
+src/interfaces/IAirlock.sol 4ms (unchanged)
+src/interfaces/ICoin.sol 40ms (unchanged)
+src/interfaces/ICoinComments.sol 5ms (unchanged)
+src/interfaces/ICoinDeployHook.sol 5ms (unchanged)
+src/interfaces/ICoinV3.sol 8ms (unchanged)
+src/interfaces/ICreatorCoin.sol 2ms (unchanged)
+src/interfaces/ICreatorCoinHook.sol 1ms (unchanged)
+src/interfaces/IDeployedCoinVersionLookup.sol 1ms (unchanged)
+src/interfaces/IDopplerErrors.sol 1ms (unchanged)
+src/interfaces/IERC7572.sol 1ms (unchanged)
+src/interfaces/IHasRewardsRecipients.sol 2ms (unchanged)
+src/interfaces/IHooksUpgradeGate.sol 3ms (unchanged)
+src/interfaces/IMsgSender.sol 1ms (unchanged)
+src/interfaces/INonfungiblePositionManager.sol 7ms (unchanged)
+src/interfaces/IPoolConfigEncoding.sol 2ms (unchanged)
+src/interfaces/IProtocolRewards.sol 15ms (unchanged)
+src/interfaces/ISwapPathRouter.sol 2ms (unchanged)
+src/interfaces/ISwapRouter.sol 1ms (unchanged)
+src/interfaces/IUniswapV3Factory.sol 9ms (unchanged)
+src/interfaces/IUniswapV3Pool.sol 6ms (unchanged)
+src/interfaces/IUniswapV3SwapCallback.sol 5ms (unchanged)
+src/interfaces/IUpgradeableV4Hook.sol 4ms (unchanged)
+src/interfaces/IWETH.sol 6ms (unchanged)
+src/interfaces/IZoraFactory.sol 23ms (unchanged)
+src/interfaces/IZoraHookRegistry.sol 5ms (unchanged)
+src/interfaces/IZoraV4CoinHook.sol 11ms (unchanged)
+src/libs/CoinCommon.sol 12ms (unchanged)
+src/libs/CoinConfigurationVersions.sol 66ms (unchanged)
+src/libs/CoinConstants.sol 15ms (unchanged)
+src/libs/CoinDopplerMultiCurve.sol 196ms (unchanged)
+src/libs/CoinRewardsV4.sol 202ms (unchanged)
+src/libs/CoinSetup.sol 53ms (unchanged)
+src/libs/DopplerMath.sol 187ms (unchanged)
+src/libs/HooksDeployment.sol 127ms (unchanged)
+src/libs/PoolStateReader.sol 5ms (unchanged)
+src/libs/UniV4SwapHelper.sol 40ms (unchanged)
+src/libs/UniV4SwapToCurrency.sol 85ms (unchanged)
+src/libs/V4Liquidity.sol 305ms (unchanged)
+src/proxy/ZoraFactory.sol 23ms (unchanged)
+src/types/LpPosition.sol 1ms (unchanged)
+src/types/PoolConfiguration.sol 2ms (unchanged)
+src/types/PoolState.sol 3ms (unchanged)
+src/utils/AutoSwapper.sol 40ms (unchanged)
+src/utils/DeployedCoinVersionLookup.sol 8ms (unchanged)
+src/utils/MultiOwnable.sol 64ms (unchanged)
+src/utils/uniswap/BitMath.sol 10ms (unchanged)
+src/utils/uniswap/BytesLib.sol 11ms (unchanged)
+src/utils/uniswap/CustomRevert.sol 55ms (unchanged)
+src/utils/uniswap/FixedPoint96.sol 1ms (unchanged)
+src/utils/uniswap/FullMath.sol 36ms (unchanged)
+src/utils/uniswap/LiquidityAmounts.sol 85ms (unchanged)
+src/utils/uniswap/Path.sol 8ms (unchanged)
+src/utils/uniswap/SafeCast.sol 20ms (unchanged)
+src/utils/uniswap/SqrtPriceMath.sol 116ms (unchanged)
+src/utils/uniswap/TickMath.sol 117ms (unchanged)
+src/utils/uniswap/UnsafeMath.sol 3ms (unchanged)
+src/version/ContractVersionBase.sol 1ms (unchanged)
+src/ZoraFactoryImpl.sol 198ms (unchanged)
+test/AutoSwapper.t.sol 87ms (unchanged)
+test/Coin.t.sol 178ms (unchanged)
+test/CoinRewardsV4.t.sol 15ms (unchanged)
+test/CoinUniV4.t.sol 618ms (unchanged)
+test/ContentCoinRewards.t.sol 216ms (unchanged)
+test/CreatorCoin.t.sol 262ms (unchanged)
+test/CreatorCoinRewards.t.sol 178ms (unchanged)
+test/DeploymentHooks.t.sol 152ms (unchanged)
+test/Factory.t.sol 150ms (unchanged)
+test/HooksDeployment.t.sol 46ms (unchanged)
+test/LiquidityMigration.t.sol 363ms (unchanged)
+test/mocks/MockERC20.sol 6ms (unchanged)
+test/MultiOwnable.t.sol 153ms (unchanged)
+test/Upgrades.t.sol 176ms (unchanged)
+test/utils/BaseTest.sol 263ms (unchanged)
+test/utils/ContractAddresses.sol 3ms (unchanged)
+test/utils/DeployedCoinVersionLookup.t.sol 70ms (unchanged)
+test/utils/FeeEstimatorHook.sol 48ms (unchanged)
+test/utils/ProtocolRewards.sol 561ms (unchanged)
+test/utils/ProxyShim.sol 12ms (unchanged)
+test/utils/RewardTestHelpers.sol 76ms (unchanged)
+test/V4Liquidity.t.sol 132ms (unchanged)
+test/ZoraHookRegistry.t.sol 237ms (unchanged)
+script/Deploy.s.sol 8ms (unchanged)
+script/DeployAutoSwapper.s.sol 16ms (unchanged)
+script/DeployDevFactory.s.sol 5ms (unchanged)
+script/DeployPostDeploymentHooks.s.sol 4ms (unchanged)
+script/DeployUpgradeGate.s.sol 5ms (unchanged)
+script/GenerateDeterministicParams.s.sol 20ms (unchanged)
+script/PrintRegisterUpgradePath.s.sol 11ms (unchanged)
+script/PrintUpgradeCommand.s.sol 3ms (unchanged)
+script/TestBackingCoinSwap.s.sol 72ms (unchanged)
+script/TestV4Swap.s.sol 67ms (unchanged)
+script/UpgradeCoinImpl.sol 7ms (unchanged)
+script/UpgradeFactoryImpl.s.sol 9ms (unchanged)
+script/UpgradeHooks.s.sol 6ms (unchanged)
+CLI Building entry: package/index.ts
+CLI Using tsconfig: tsconfig.json
+CLI tsup v8.4.0
+CLI Using tsup config: /home/runner/work/zora-protocol-private/zora-protocol-private/packages/coins/tsup.config.ts
+CLI Target: es2021
+CLI Cleaning output folder
+CJS Build start
+ESM Build start
+ESM dist/index.js     130.77 KB
+ESM dist/index.js.map 233.85 KB
+ESM ⚡️ Build success in 86ms
+CJS dist/index.cjs     132.20 KB
+CJS dist/index.cjs.map 234.00 KB
+CJS ⚡️ Build success in 88ms

package/CHANGELOG.md

@@ -1,5 +1,98 @@
 # @zoralabs/coins
 
+## 2.3.0
+
+### Minor Changes
+
+- 7df94915: Enable buying initial supply when deploying creator coin and refactor factory internals
+
+  - Add new `deployCreatorCoin` overload with `postDeployHook` parameter that supports ETH transfers
+  - Refactored internal factory implementation to share more code between deployment methods
+  - Enables buying initial supply during creator coin deployment via post-deploy hooks
+
+### Patch Changes
+
+- 6a7e2b7b: Fix LP position duplication when deploying coins. If two positions are created with the same tick ranges, they are merged and stored as one position. This reduces gas costs during swapping as there are less LP positions to iterate through when collecting fees.
+- 5093c5ef: Add bounds checking to prevent risky forced downcasting of currency deltas
+- 9c6d241a: Fix ETH transfer failures in reward distribution when platform referrers cannot accept ETH
+
+  - Prevent swaps from reverting when platform referrers cannot accept ETH - in this case, the rewards are redirected to the protocol recipient as backup.
+  - Ensures coin functionality remains intact even with ETH-incompatible platform referrers
+
+- 44a179b0: Flatten hooks into single hook implementation
+
+  Consolidates multiple hook contracts into a single unified hook for simplified architecture and better maintainability.
+
+- d3808d55: Adjust creator coin vesting duration to account for leap years
+
+  - Changed CREATOR_VESTING_DURATION from 5 _ 365 days to 5 _ 365.25 days
+  - Addresses Cantina audit finding about 1.25 day shortfall in 5-year vesting period
+
+- b571fe54: Consolidate and clarify coin constants
+
+  - Renamed `CREATOR_LAUNCH_REWARD` to `CONTENT_COIN_INITIAL_CREATOR_SUPPLY` for clarity
+  - Renamed `CREATOR_VESTING_SUPPLY` to `CREATOR_COIN_CREATOR_VESTING_SUPPLY` for consistency
+  - Removed redundant `POOL_LAUNCH_SUPPLY` constant (use `CONTENT_COIN_MARKET_SUPPLY` instead)
+  - Changed library constants from `public` to `internal`
+  - Made supply constants derived from calculations to show relationships clearly
+
+- 32d683d6: Fix stale PoolKey mapping after migration in ZoraV4CoinHook
+
+  Delete the old pool key from the poolCoins mapping after successful liquidity migration to prevent future operations on migrated pools.
+
+- 44a179b0: Ignore collecting from liquidity positions with empty fee growth
+- 00b982bb: Fix liquidity migration bug: when migrating liquidity to a hook with a different fee, the old fee was kept. This will now make sure that the new fee is used after migration. Also make sure to use the new tick spacing after migration.
+
+## 2.2.1
+
+### Patch Changes
+
+- c96e0c5e: Fix bug where liquidity cannot be migrated if there is a position with 0 liquidity
+
+## 2.2.0
+
+### Minor Changes
+
+- adf98059: Adds platform referral and trade referral functionality to creator coins, and unifies the fee structure between content and creator coins with a simplified 1% total fee.
+
+  ## New Features:
+
+  - Platform referral and trade referral functionality for creator coins (previously only supported on content coins)
+  - Unified fee structure: Both content and creator coins use identical 1% fee distribution
+
+  ### Fee Changes - Content Coins
+
+  | Recipient         | Before (3% total fee) | After (1% total fee) |
+  | ----------------- | --------------------- | -------------------- |
+  |                   | % of Fee              | % of Fee             |
+  | Creator           | 33.33%                | 50%                  |
+  | Platform Referral | 10%                   | 20%                  |
+  | Trade Referral    | 10%                   | 4%                   |
+  | Doppler           | 3.33%                 | 1%                   |
+  | Protocol          | 10%                   | 5%                   |
+  | LP Rewards        | 33.33%                | 20%                  |
+
+  ### Fee Changes - Creator Coins
+
+  | Recipient         | Before (3% total fee) | After (1% total fee) |
+  | ----------------- | --------------------- | -------------------- |
+  |                   | % of Fee              | % of Fee             |
+  | Creator           | 33.33%                | 50%                  |
+  | Platform Referral | -                     | 20%                  |
+  | Trade Referral    | -                     | 4%                   |
+  | Doppler           | -                     | 1%                   |
+  | Protocol          | 33.33%                | 5%                   |
+  | LP Rewards        | 33.33%                | 20%                  |
+
+  **Implementation Changes:**
+
+  - Consolidated reward logic into `CoinRewardsV4.distributeMarketRewards()`
+
+  **Backwards Compatibility:**
+
+  - Existing `CreatorCoinRewards` event is still emitted for backwards compatibility when rewards are distributed for a CreatorCoin
+  - Additionally, when market rewards are distributed for a CreatorCoin, the same `CoinMarketRewardsV4` event that is already emitted for ContentCoins is now also emitted
+
 ## 2.1.2
 
 ### Patch Changes

package/README.md

@@ -74,3 +74,7 @@ forge script script/Deploy.s.sol $(chains {chainName} --deploy) --broadcast --ve
 where `{chainName}` is the emdash name of the chain you want to deploy on.
 
 2. Verify the factory contract. Since it is deployed with create2, foundry won't always recognize the deployed contract; verification instructions will be printed out in the logs.
+
+## Audits
+
+* Coins Aug 2025: [Cantina Audit Report](./audits/report-cantinacode-zora-0827.pdf)

package/abis/BaseCoin.json

@@ -131,6 +131,19 @@
     "outputs": [],
     "stateMutability": "nonpayable"
   },
+  {
+    "type": "function",
+    "name": "coinType",
+    "inputs": [],
+    "outputs": [
+      {
+        "name": "",
+        "type": "uint8",
+        "internalType": "enum IHasCoinType.CoinType"
+      }
+    ],
+    "stateMutability": "view"
+  },
   {
     "type": "function",
     "name": "contractURI",
@@ -890,6 +903,19 @@
     ],
     "stateMutability": "view"
   },
+  {
+    "type": "function",
+    "name": "totalSupplyForPositions",
+    "inputs": [],
+    "outputs": [
+      {
+        "name": "",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "stateMutability": "view"
+  },
   {
     "type": "function",
     "name": "transfer",
@@ -1822,11 +1848,6 @@
     "name": "OwnerCannotBeAddressZero",
     "inputs": []
   },
-  {
-    "type": "error",
-    "name": "ReentrancyGuardReentrantCall",
-    "inputs": []
-  },
   {
     "type": "error",
     "name": "SlippageBoundsExceeded",

package/abis/BaseTest.json

@@ -91,7 +91,7 @@
   },
   {
     "type": "function",
-    "name": "getSalts",
+    "name": "getSalt",
     "inputs": [
       {
         "name": "trustedMessageSenders",
@@ -101,12 +101,7 @@
     ],
     "outputs": [
       {
-        "name": "contentCoinSalt",
-        "type": "bytes32",
-        "internalType": "bytes32"
-      },
-      {
-        "name": "creatorCoinSalt",
+        "name": "hookSalt",
         "type": "bytes32",
         "internalType": "bytes32"
       }

package/abis/ContentCoin.json

@@ -157,6 +157,19 @@
     "outputs": [],
     "stateMutability": "nonpayable"
   },
+  {
+    "type": "function",
+    "name": "coinType",
+    "inputs": [],
+    "outputs": [
+      {
+        "name": "",
+        "type": "uint8",
+        "internalType": "enum IHasCoinType.CoinType"
+      }
+    ],
+    "stateMutability": "pure"
+  },
   {
     "type": "function",
     "name": "contractURI",
@@ -916,6 +929,19 @@
     ],
     "stateMutability": "view"
   },
+  {
+    "type": "function",
+    "name": "totalSupplyForPositions",
+    "inputs": [],
+    "outputs": [
+      {
+        "name": "",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "stateMutability": "pure"
+  },
   {
     "type": "function",
     "name": "transfer",
@@ -1848,11 +1874,6 @@
     "name": "OwnerCannotBeAddressZero",
     "inputs": []
   },
-  {
-    "type": "error",
-    "name": "ReentrancyGuardReentrantCall",
-    "inputs": []
-  },
   {
     "type": "error",
     "name": "SlippageBoundsExceeded",

package/abis/CreatorCoin.json

@@ -3,22 +3,22 @@
     "type": "constructor",
     "inputs": [
       {
-        "name": "_protocolRewardRecipient",
+        "name": "protocolRewardRecipient_",
         "type": "address",
         "internalType": "address"
       },
       {
-        "name": "_protocolRewards",
+        "name": "protocolRewards_",
         "type": "address",
         "internalType": "address"
       },
       {
-        "name": "_poolManager",
+        "name": "poolManager_",
         "type": "address",
         "internalType": "contract IPoolManager"
       },
       {
-        "name": "_airlock",
+        "name": "airlock_",
         "type": "address",
         "internalType": "address"
       }
@@ -170,6 +170,19 @@
     ],
     "stateMutability": "nonpayable"
   },
+  {
+    "type": "function",
+    "name": "coinType",
+    "inputs": [],
+    "outputs": [
+      {
+        "name": "",
+        "type": "uint8",
+        "internalType": "enum IHasCoinType.CoinType"
+      }
+    ],
+    "stateMutability": "pure"
+  },
   {
     "type": "function",
     "name": "contractURI",
@@ -955,6 +968,19 @@
     ],
     "stateMutability": "view"
   },
+  {
+    "type": "function",
+    "name": "totalSupplyForPositions",
+    "inputs": [],
+    "outputs": [
+      {
+        "name": "",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "stateMutability": "pure"
+  },
   {
     "type": "function",
     "name": "transfer",
@@ -1955,11 +1981,6 @@
     "name": "OwnerCannotBeAddressZero",
     "inputs": []
   },
-  {
-    "type": "error",
-    "name": "ReentrancyGuardReentrantCall",
-    "inputs": []
-  },
   {
     "type": "error",
     "name": "SlippageBoundsExceeded",

package/abis/FeeEstimatorHook.json

@@ -16,11 +16,6 @@
         "name": "upgradeGate",
         "type": "address",
         "internalType": "contract IHooksUpgradeGate"
-      },
-      {
-        "name": "initialSupplyForPositions",
-        "type": "uint256",
-        "internalType": "uint256"
       }
     ],
     "stateMutability": "nonpayable"
@@ -1248,7 +1243,7 @@
         ]
       },
       {
-        "name": "",
+        "name": "additionalData",
         "type": "bytes",
         "internalType": "bytes"
       }
@@ -1256,6 +1251,99 @@
     "outputs": [],
     "stateMutability": "nonpayable"
   },
+  {
+    "type": "function",
+    "name": "initializeFromMigrationWithUpdateableFee",
+    "inputs": [
+      {
+        "name": "poolKey",
+        "type": "tuple",
+        "internalType": "struct PoolKey",
+        "components": [
+          {
+            "name": "currency0",
+            "type": "address",
+            "internalType": "Currency"
+          },
+          {
+            "name": "currency1",
+            "type": "address",
+            "internalType": "Currency"
+          },
+          {
+            "name": "fee",
+            "type": "uint24",
+            "internalType": "uint24"
+          },
+          {
+            "name": "tickSpacing",
+            "type": "int24",
+            "internalType": "int24"
+          },
+          {
+            "name": "hooks",
+            "type": "address",
+            "internalType": "contract IHooks"
+          }
+        ]
+      },
+      {
+        "name": "coin",
+        "type": "address",
+        "internalType": "address"
+      },
+      {
+        "name": "sqrtPriceX96",
+        "type": "uint160",
+        "internalType": "uint160"
+      },
+      {
+        "name": "migratedLiquidity",
+        "type": "tuple[]",
+        "internalType": "struct BurnedPosition[]",
+        "components": [
+          {
+            "name": "tickLower",
+            "type": "int24",
+            "internalType": "int24"
+          },
+          {
+            "name": "tickUpper",
+            "type": "int24",
+            "internalType": "int24"
+          },
+          {
+            "name": "amount0Received",
+            "type": "uint128",
+            "internalType": "uint128"
+          },
+          {
+            "name": "amount1Received",
+            "type": "uint128",
+            "internalType": "uint128"
+          }
+        ]
+      },
+      {
+        "name": "additionalData",
+        "type": "bytes",
+        "internalType": "bytes"
+      }
+    ],
+    "outputs": [
+      {
+        "name": "fee",
+        "type": "uint24",
+        "internalType": "uint24"
+      },
+      {
+        "name": "tickSpacing",
+        "type": "int24",
+        "internalType": "int24"
+      }
+    ],
+    "stateMutability": "nonpayable"
+  },
   {
     "type": "function",
     "name": "isTrustedMessageSender",

package/abis/ICoin.json

@@ -25,6 +25,19 @@
     "outputs": [],
     "stateMutability": "nonpayable"
   },
+  {
+    "type": "function",
+    "name": "coinType",
+    "inputs": [],
+    "outputs": [
+      {
+        "name": "",
+        "type": "uint8",
+        "internalType": "enum IHasCoinType.CoinType"
+      }
+    ],
+    "stateMutability": "view"
+  },
   {
     "type": "function",
     "name": "contractURI",
@@ -446,6 +459,19 @@
     ],
     "stateMutability": "view"
   },
+  {
+    "type": "function",
+    "name": "totalSupplyForPositions",
+    "inputs": [],
+    "outputs": [
+      {
+        "name": "",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "stateMutability": "view"
+  },
   {
     "type": "event",
     "name": "CoinBuy",

package/abis/ICoinV3.json

@@ -95,6 +95,19 @@
     "outputs": [],
     "stateMutability": "nonpayable"
   },
+  {
+    "type": "function",
+    "name": "coinType",
+    "inputs": [],
+    "outputs": [
+      {
+        "name": "",
+        "type": "uint8",
+        "internalType": "enum IHasCoinType.CoinType"
+      }
+    ],
+    "stateMutability": "view"
+  },
   {
     "type": "function",
     "name": "contractURI",
@@ -690,6 +703,19 @@
     ],
     "stateMutability": "view"
   },
+  {
+    "type": "function",
+    "name": "totalSupplyForPositions",
+    "inputs": [],
+    "outputs": [
+      {
+        "name": "",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "stateMutability": "view"
+  },
   {
     "type": "function",
     "name": "v3Factory",