@zoralabs/coins 2.1.1 → 2.2.1

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

@@ -0,0 +1,152 @@
+
+> @zoralabs/coins@2.2.1 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.2.1 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.2.1 build:contracts:minimal /home/runner/work/zora-protocol-private/zora-protocol-private/packages/coins
+> forge build --skip test --skip script --no-metadata
+
+Compiling 212 files with Solc 0.8.28
+Solc 0.8.28 finished in 80.04s
+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.2.1 copy-abis /home/runner/work/zora-protocol-private/zora-protocol-private/packages/coins
+> pnpm exec bundle-abis
+
+
+> @zoralabs/coins@2.2.1 prettier:write /home/runner/work/zora-protocol-private/zora-protocol-private/packages/coins
+> prettier --write 'src/**/*.sol' 'test/**/*.sol' 'script/**/*.sol'
+
+src/BaseCoin.sol 780ms (unchanged)
+src/ContentCoin.sol 81ms (unchanged)
+src/CreatorCoin.sol 95ms (unchanged)
+src/deployment/CoinsDeployerBase.sol 344ms (unchanged)
+src/hook-registry/ZoraHookRegistry.sol 142ms (unchanged)
+src/hooks/deployment/BaseCoinDeployHook.sol 40ms (unchanged)
+src/hooks/deployment/BuySupplyWithSwapRouterHook.sol 257ms (unchanged)
+src/hooks/HookUpgradeGate.sol 33ms (unchanged)
+src/hooks/ZoraV4CoinHook.sol 250ms (unchanged)
+src/interfaces/IAirlock.sol 4ms (unchanged)
+src/interfaces/ICoin.sol 27ms (unchanged)
+src/interfaces/ICoinComments.sol 5ms (unchanged)
+src/interfaces/ICoinDeployHook.sol 1ms (unchanged)
+src/interfaces/ICoinV3.sol 9ms (unchanged)
+src/interfaces/ICreatorCoin.sol 2ms (unchanged)
+src/interfaces/ICreatorCoinHook.sol 2ms (unchanged)
+src/interfaces/IDeployedCoinVersionLookup.sol 3ms (unchanged)
+src/interfaces/IDopplerErrors.sol 2ms (unchanged)
+src/interfaces/IERC7572.sol 3ms (unchanged)
+src/interfaces/IHasRewardsRecipients.sol 3ms (unchanged)
+src/interfaces/IHooksUpgradeGate.sol 3ms (unchanged)
+src/interfaces/IMsgSender.sol 2ms (unchanged)
+src/interfaces/INonfungiblePositionManager.sol 8ms (unchanged)
+src/interfaces/IPoolConfigEncoding.sol 1ms (unchanged)
+src/interfaces/IProtocolRewards.sol 6ms (unchanged)
+src/interfaces/ISwapPathRouter.sol 3ms (unchanged)
+src/interfaces/ISwapRouter.sol 3ms (unchanged)
+src/interfaces/IUniswapV3Factory.sol 9ms (unchanged)
+src/interfaces/IUniswapV3Pool.sol 5ms (unchanged)
+src/interfaces/IUniswapV3SwapCallback.sol 3ms (unchanged)
+src/interfaces/IUpgradeableV4Hook.sol 3ms (unchanged)
+src/interfaces/IWETH.sol 9ms (unchanged)
+src/interfaces/IZoraFactory.sol 25ms (unchanged)
+src/interfaces/IZoraHookRegistry.sol 11ms (unchanged)
+src/interfaces/IZoraV4CoinHook.sol 15ms (unchanged)
+src/libs/CoinCommon.sol 8ms (unchanged)
+src/libs/CoinConfigurationVersions.sol 69ms (unchanged)
+src/libs/CoinConstants.sol 4ms (unchanged)
+src/libs/CoinDopplerMultiCurve.sol 186ms (unchanged)
+src/libs/CoinRewardsV4.sol 189ms (unchanged)
+src/libs/CoinSetup.sol 53ms (unchanged)
+src/libs/CreatorCoinConstants.sol 4ms (unchanged)
+src/libs/DopplerMath.sol 161ms (unchanged)
+src/libs/HooksDeployment.sol 128ms (unchanged)
+src/libs/MarketConstants.sol 5ms (unchanged)
+src/libs/PoolStateReader.sol 6ms (unchanged)
+src/libs/UniV4SwapHelper.sol 47ms (unchanged)
+src/libs/UniV4SwapToCurrency.sol 82ms (unchanged)
+src/libs/V4Liquidity.sol 250ms (unchanged)
+src/proxy/ZoraFactory.sol 20ms (unchanged)
+src/types/LpPosition.sol 1ms (unchanged)
+src/types/PoolConfiguration.sol 3ms (unchanged)
+src/types/PoolState.sol 4ms (unchanged)
+src/utils/AutoSwapper.sol 29ms (unchanged)
+src/utils/DeployedCoinVersionLookup.sol 8ms (unchanged)
+src/utils/MultiOwnable.sol 66ms (unchanged)
+src/utils/uniswap/BitMath.sol 23ms (unchanged)
+src/utils/uniswap/BytesLib.sol 13ms (unchanged)
+src/utils/uniswap/CustomRevert.sol 55ms (unchanged)
+src/utils/uniswap/FixedPoint96.sol 2ms (unchanged)
+src/utils/uniswap/FullMath.sol 35ms (unchanged)
+src/utils/uniswap/LiquidityAmounts.sol 94ms (unchanged)
+src/utils/uniswap/Path.sol 8ms (unchanged)
+src/utils/uniswap/SafeCast.sol 19ms (unchanged)
+src/utils/uniswap/SqrtPriceMath.sol 118ms (unchanged)
+src/utils/uniswap/TickMath.sol 142ms (unchanged)
+src/utils/uniswap/UnsafeMath.sol 6ms (unchanged)
+src/version/ContractVersionBase.sol 1ms (unchanged)
+src/ZoraFactoryImpl.sol 205ms (unchanged)
+test/AutoSwapper.t.sol 64ms (unchanged)
+test/Coin.t.sol 200ms (unchanged)
+test/CoinUniV4.t.sol 633ms (unchanged)
+test/ContentCoinRewards.t.sol 190ms (unchanged)
+test/CreatorCoin.t.sol 237ms (unchanged)
+test/CreatorCoinRewards.t.sol 159ms (unchanged)
+test/DeploymentHooks.t.sol 131ms (unchanged)
+test/Factory.t.sol 161ms (unchanged)
+test/HooksDeployment.t.sol 43ms (unchanged)
+test/LiquidityMigration.t.sol 263ms (unchanged)
+test/mocks/MockERC20.sol 4ms (unchanged)
+test/MultiOwnable.t.sol 138ms (unchanged)
+test/Upgrades.t.sol 191ms (unchanged)
+test/utils/BaseTest.sol 272ms (unchanged)
+test/utils/ContractAddresses.sol 4ms (unchanged)
+test/utils/DeployedCoinVersionLookup.t.sol 73ms (unchanged)
+test/utils/FeeEstimatorHook.sol 44ms (unchanged)
+test/utils/ProtocolRewards.sol 480ms (unchanged)
+test/utils/ProxyShim.sol 5ms (unchanged)
+test/utils/RewardTestHelpers.sol 94ms (unchanged)
+test/ZoraHookRegistry.t.sol 221ms (unchanged)
+script/Deploy.s.sol 8ms (unchanged)
+script/DeployAutoSwapper.s.sol 12ms (unchanged)
+script/DeployDevFactory.s.sol 4ms (unchanged)
+script/DeployPostDeploymentHooks.s.sol 4ms (unchanged)
+script/DeployUpgradeGate.s.sol 5ms (unchanged)
+script/GenerateDeterministicParams.s.sol 20ms (unchanged)
+script/PrintRegisterUpgradePath.s.sol 13ms (unchanged)
+script/PrintUpgradeCommand.s.sol 5ms (unchanged)
+script/TestBackingCoinSwap.s.sol 63ms (unchanged)
+script/TestV4Swap.s.sol 65ms (unchanged)
+script/UpgradeCoinImpl.sol 7ms (unchanged)
+script/UpgradeFactoryImpl.s.sol 10ms (unchanged)
+script/UpgradeHooks.s.sol 7ms (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.01 KB
+ESM dist/index.js.map 232.56 KB
+ESM ⚡️ Build success in 77ms
+CJS dist/index.cjs     131.44 KB
+CJS dist/index.cjs.map 232.71 KB
+CJS ⚡️ Build success in 82ms

package/CHANGELOG.md

@@ -1,5 +1,65 @@
 # @zoralabs/coins
 
+## 2.2.1
+
+### Patch Changes
+
+- 7ec6134b: Flatten hooks into single hook implementation
+
+  Consolidates multiple hook contracts into a single unified hook for simplified architecture and better maintainability.
+
+- ae9424ab: Ignore collecting from liquidity positions with empty fee growth
+
+## 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
+
+- 8b85ab94: Removed some unused constants
+
 ## 2.1.1
 
 ### Patch Changes

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",

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/CoinConstants.json

@@ -12,32 +12,6 @@
     ],
     "stateMutability": "view"
   },
-  {
-    "type": "function",
-    "name": "CREATOR_MARKET_REWARD_BPS",
-    "inputs": [],
-    "outputs": [
-      {
-        "name": "",
-        "type": "uint256",
-        "internalType": "uint256"
-      }
-    ],
-    "stateMutability": "view"
-  },
-  {
-    "type": "function",
-    "name": "DOPPLER_MARKET_REWARD_BPS",
-    "inputs": [],
-    "outputs": [
-      {
-        "name": "",
-        "type": "uint256",
-        "internalType": "uint256"
-      }
-    ],
-    "stateMutability": "view"
-  },
   {
     "type": "function",
     "name": "MAX_TOTAL_SUPPLY",
@@ -64,32 +38,6 @@
     ],
     "stateMutability": "view"
   },
-  {
-    "type": "function",
-    "name": "PLATFORM_REFERRER_FEE_BPS",
-    "inputs": [],
-    "outputs": [
-      {
-        "name": "",
-        "type": "uint256",
-        "internalType": "uint256"
-      }
-    ],
-    "stateMutability": "view"
-  },
-  {
-    "type": "function",
-    "name": "PLATFORM_REFERRER_MARKET_REWARD_BPS",
-    "inputs": [],
-    "outputs": [
-      {
-        "name": "",
-        "type": "uint256",
-        "internalType": "uint256"
-      }
-    ],
-    "stateMutability": "view"
-  },
   {
     "type": "function",
     "name": "POOL_LAUNCH_SUPPLY",
@@ -102,57 +50,5 @@
       }
     ],
     "stateMutability": "view"
-  },
-  {
-    "type": "function",
-    "name": "PROTOCOL_FEE_BPS",
-    "inputs": [],
-    "outputs": [
-      {
-        "name": "",
-        "type": "uint256",
-        "internalType": "uint256"
-      }
-    ],
-    "stateMutability": "view"
-  },
-  {
-    "type": "function",
-    "name": "TOKEN_CREATOR_FEE_BPS",
-    "inputs": [],
-    "outputs": [
-      {
-        "name": "",
-        "type": "uint256",
-        "internalType": "uint256"
-      }
-    ],
-    "stateMutability": "view"
-  },
-  {
-    "type": "function",
-    "name": "TOTAL_FEE_BPS",
-    "inputs": [],
-    "outputs": [
-      {
-        "name": "",
-        "type": "uint256",
-        "internalType": "uint256"
-      }
-    ],
-    "stateMutability": "view"
-  },
-  {
-    "type": "function",
-    "name": "TRADE_REFERRER_FEE_BPS",
-    "inputs": [],
-    "outputs": [
-      {
-        "name": "",
-        "type": "uint256",
-        "internalType": "uint256"
-      }
-    ],
-    "stateMutability": "view"
   }
 ]

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",

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",

package/abis/FeeEstimatorHook.json

@@ -16,11 +16,6 @@
         "name": "upgradeGate",
         "type": "address",
         "internalType": "contract IHooksUpgradeGate"
-      },
-      {
-        "name": "initialSupplyForPositions",
-        "type": "uint256",
-        "internalType": "uint256"
       }
     ],
     "stateMutability": "nonpayable"

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",

package/abis/ICreatorCoin.json

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