@zoralabs/coins 2.0.0 → 2.1.0

package/.turbo/turbo-build.log

@@ -1,33 +1,39 @@
 
-> @zoralabs/coins@2.0.0 build /home/runner/work/zora-protocol-private/zora-protocol-private/packages/coins
+> @zoralabs/coins@2.1.0 build /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.0.0 wagmi:generate /home/runner/work/zora-protocol-private/zora-protocol-private/packages/coins
+> @zoralabs/coins@2.1.0 wagmi:generate /home/runner/work/zora-protocol-private/zora-protocol-private/packages/coins
 > FOUNDRY_PROFILE=dev forge build && wagmi generate && pnpm exec rename-generated-abi-casing ./package/wagmiGenerated.ts
 
-Compiling 246 files with Solc 0.8.28
-Solc 0.8.28 finished in 226.34s
+Compiling 236 files with Solc 0.8.28
+Solc 0.8.28 finished in 186.86s
 Compiler run successful with warnings:
 Warning (3420): Source file does not specify required compiler version! Consider adding "pragma solidity ^0.8.28;"
 --> src/BaseCoin.sol
 
 Warning (5667): Unused function parameter. Remove or comment out the variable name to silence this warning.
-   --> src/deployment/CoinsDeployerBase.sol:117:31:
+   --> src/ZoraFactoryImpl.sol:214:9:
     |
-117 |     function deployCoinV4Impl(address zoraV4CoinHook) internal returns (ContentCoin) {
+214 |         uint256 orderSize
+    |         ^^^^^^^^^^^^^^^^^
+
+Warning (5667): Unused function parameter. Remove or comment out the variable name to silence this warning.
+   --> src/deployment/CoinsDeployerBase.sol:104:31:
+    |
+104 |     function deployCoinV4Impl(address zoraV4CoinHook) internal returns (ContentCoin) {
     |                               ^^^^^^^^^^^^^^^^^^^^^^
 
 Warning (5667): Unused function parameter. Remove or comment out the variable name to silence this warning.
-   --> src/deployment/CoinsDeployerBase.sol:127:36:
+   --> src/deployment/CoinsDeployerBase.sol:114:36:
     |
-127 |     function deployCreatorCoinImpl(address creatorCoinHook) internal returns (CreatorCoin) {
+114 |     function deployCreatorCoinImpl(address creatorCoinHook) internal returns (CreatorCoin) {
     |                                    ^^^^^^^^^^^^^^^^^^^^^^^
 
 Warning (5667): Unused function parameter. Remove or comment out the variable name to silence this warning.
-   --> src/deployment/CoinsDeployerBase.sol:290:84:
+   --> src/deployment/CoinsDeployerBase.sol:273:84:
     |
-290 |     function deployDevFactory(CoinsDeployment memory deployment) internal returns (ZoraFactory devFactory) {
+273 |     function deployDevFactory(CoinsDeployment memory deployment) internal returns (ZoraFactory devFactory) {
     |                                                                                    ^^^^^^^^^^^^^^^^^^^^^^
 
 Warning (2072): Unused local variable.
@@ -49,15 +55,15 @@ Warning (2072): Unused local variable.
     |         ^^^^^^^^^^^^^^^^^^^^^^
 
 Warning (2072): Unused local variable.
-   --> test/LiquidityMigration.t.sol:186:9:
+   --> test/LiquidityMigration.t.sol:188:9:
     |
-186 |         address originalHook = address(contentCoinHook);
+188 |         address originalHook = address(contentCoinHook);
     |         ^^^^^^^^^^^^^^^^^^^^
 
 Warning (2072): Unused local variable.
-   --> test/LiquidityMigration.t.sol:208:9:
+   --> test/LiquidityMigration.t.sol:210:9:
     |
-208 |         PoolKey memory poolKey = coinV4.getPoolKey();
+210 |         PoolKey memory poolKey = coinV4.getPoolKey();
     |         ^^^^^^^^^^^^^^^^^^^^^^
 
 - Validating plugins
@@ -73,123 +79,113 @@ Warning (2072): Unused local variable.
 ✅ Updated ./package/wagmiGenerated.ts (10 replacements)
 ✨ All files processed successfully!
 
-> @zoralabs/coins@2.0.0 copy-abis /home/runner/work/zora-protocol-private/zora-protocol-private/packages/coins
+> @zoralabs/coins@2.1.0 copy-abis /home/runner/work/zora-protocol-private/zora-protocol-private/packages/coins
 > pnpm exec bundle-abis
 
 
-> @zoralabs/coins@2.0.0 prettier:write /home/runner/work/zora-protocol-private/zora-protocol-private/packages/coins
+> @zoralabs/coins@2.1.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 331ms (unchanged)
-src/BaseCoinV4.sol 110ms (unchanged)
-src/Coin.sol 124ms (unchanged)
-src/ContentCoin.sol 25ms (unchanged)
-src/CreatorCoin.sol 47ms (unchanged)
-src/deployment/CoinsDeployerBase.sol 189ms (unchanged)
-src/hooks/BaseZoraV4CoinHook.sol 183ms (unchanged)
-src/hooks/ContentCoinHook.sol 9ms (unchanged)
-src/hooks/CreatorCoinHook.sol 6ms (unchanged)
-src/hooks/deployment/BaseCoinDeployHook.sol 11ms (unchanged)
-src/hooks/deployment/BuySupplyWithSwapRouterHook.sol 130ms (unchanged)
-src/hooks/HookUpgradeGate.sol 23ms (unchanged)
-src/interfaces/IAirlock.sol 2ms (unchanged)
+src/BaseCoin.sol 423ms (unchanged)
+src/ContentCoin.sol 34ms (unchanged)
+src/CreatorCoin.sol 63ms (unchanged)
+src/deployment/CoinsDeployerBase.sol 216ms (unchanged)
+src/hooks/BaseZoraV4CoinHook.sol 180ms (unchanged)
+src/hooks/ContentCoinHook.sol 7ms (unchanged)
+src/hooks/CreatorCoinHook.sol 7ms (unchanged)
+src/hooks/deployment/BaseCoinDeployHook.sol 20ms (unchanged)
+src/hooks/deployment/BuySupplyWithSwapRouterHook.sol 118ms (unchanged)
+src/hooks/HookUpgradeGate.sol 22ms (unchanged)
+src/interfaces/IAirlock.sol 1ms (unchanged)
 src/interfaces/ICoin.sol 13ms (unchanged)
-src/interfaces/ICoinComments.sol 2ms (unchanged)
+src/interfaces/ICoinComments.sol 1ms (unchanged)
 src/interfaces/ICoinDeployHook.sol 1ms (unchanged)
 src/interfaces/ICoinV3.sol 3ms (unchanged)
-src/interfaces/ICoinV4.sol 2ms (unchanged)
-src/interfaces/ICreatorCoin.sol 1ms (unchanged)
-src/interfaces/ICreatorCoinHook.sol 1ms (unchanged)
+src/interfaces/ICreatorCoin.sol 2ms (unchanged)
+src/interfaces/ICreatorCoinHook.sol 2ms (unchanged)
 src/interfaces/IDeployedCoinVersionLookup.sol 1ms (unchanged)
-src/interfaces/IDopplerErrors.sol 0ms (unchanged)
-src/interfaces/IERC7572.sol 1ms (unchanged)
+src/interfaces/IDopplerErrors.sol 1ms (unchanged)
+src/interfaces/IERC7572.sol 0ms (unchanged)
 src/interfaces/IHasRewardsRecipients.sol 1ms (unchanged)
-src/interfaces/IHooksUpgradeGate.sol 2ms (unchanged)
+src/interfaces/IHooksUpgradeGate.sol 1ms (unchanged)
 src/interfaces/IMsgSender.sol 1ms (unchanged)
-src/interfaces/INonfungiblePositionManager.sol 8ms (unchanged)
+src/interfaces/INonfungiblePositionManager.sol 4ms (unchanged)
 src/interfaces/IPoolConfigEncoding.sol 2ms (unchanged)
-src/interfaces/IProtocolRewards.sol 3ms (unchanged)
+src/interfaces/IProtocolRewards.sol 2ms (unchanged)
 src/interfaces/ISwapPathRouter.sol 1ms (unchanged)
-src/interfaces/ISwapRouter.sol 0ms (unchanged)
-src/interfaces/IUniswapV3Factory.sol 2ms (unchanged)
+src/interfaces/ISwapRouter.sol 1ms (unchanged)
+src/interfaces/IUniswapV3Factory.sol 5ms (unchanged)
 src/interfaces/IUniswapV3Pool.sol 3ms (unchanged)
-src/interfaces/IUniswapV3SwapCallback.sol 2ms (unchanged)
+src/interfaces/IUniswapV3SwapCallback.sol 1ms (unchanged)
 src/interfaces/IUpgradeableV4Hook.sol 2ms (unchanged)
-src/interfaces/IWETH.sol 2ms (unchanged)
-src/interfaces/IZoraFactory.sol 10ms (unchanged)
-src/interfaces/IZoraV4CoinHook.sol 7ms (unchanged)
-src/libs/CoinCommon.sol 10ms (unchanged)
-src/libs/CoinConfigurationVersions.sol 52ms (unchanged)
-src/libs/CoinConstants.sol 3ms (unchanged)
-src/libs/CoinDopplerMultiCurve.sol 106ms (unchanged)
-src/libs/CoinDopplerUniV3.sol 28ms (unchanged)
-src/libs/CoinRewards.sol 113ms (unchanged)
-src/libs/CoinRewardsV4.sol 102ms (unchanged)
-src/libs/CoinSetup.sol 23ms (unchanged)
-src/libs/CoinSetupV3.sol 14ms (unchanged)
+src/interfaces/IWETH.sol 1ms (unchanged)
+src/interfaces/IZoraFactory.sol 12ms (unchanged)
+src/interfaces/IZoraV4CoinHook.sol 6ms (unchanged)
+src/libs/CoinCommon.sol 4ms (unchanged)
+src/libs/CoinConfigurationVersions.sol 46ms (unchanged)
+src/libs/CoinConstants.sol 4ms (unchanged)
+src/libs/CoinDopplerMultiCurve.sol 103ms (unchanged)
+src/libs/CoinRewardsV4.sol 99ms (unchanged)
+src/libs/CoinSetup.sol 26ms (unchanged)
 src/libs/CreatorCoinConstants.sol 2ms (unchanged)
-src/libs/CreatorCoinRewards.sol 10ms (unchanged)
+src/libs/CreatorCoinRewards.sol 18ms (unchanged)
 src/libs/DopplerMath.sol 88ms (unchanged)
-src/libs/HooksDeployment.sol 85ms (unchanged)
+src/libs/HooksDeployment.sol 79ms (unchanged)
 src/libs/MarketConstants.sol 2ms (unchanged)
-src/libs/PoolStateReader.sol 7ms (unchanged)
-src/libs/UniV3BuySell.sol 78ms (unchanged)
-src/libs/UniV3Errors.sol 1ms (unchanged)
-src/libs/UniV4SwapHelper.sol 24ms (unchanged)
-src/libs/UniV4SwapToCurrency.sol 52ms (unchanged)
-src/libs/V4Liquidity.sol 136ms (unchanged)
-src/proxy/ZoraFactory.sol 7ms (unchanged)
+src/libs/PoolStateReader.sol 6ms (unchanged)
+src/libs/UniV4SwapHelper.sol 29ms (unchanged)
+src/libs/UniV4SwapToCurrency.sol 48ms (unchanged)
+src/libs/V4Liquidity.sol 131ms (unchanged)
+src/proxy/ZoraFactory.sol 5ms (unchanged)
 src/types/LpPosition.sol 1ms (unchanged)
-src/types/PoolConfiguration.sol 1ms (unchanged)
+src/types/PoolConfiguration.sol 3ms (unchanged)
 src/types/PoolState.sol 1ms (unchanged)
-src/utils/AutoSwapper.sol 19ms (unchanged)
+src/utils/AutoSwapper.sol 20ms (unchanged)
 src/utils/DeployedCoinVersionLookup.sol 4ms (unchanged)
-src/utils/MultiOwnable.sol 39ms (unchanged)
-src/utils/uniswap/BitMath.sol 11ms (unchanged)
-src/utils/uniswap/BytesLib.sol 15ms (unchanged)
-src/utils/uniswap/CustomRevert.sol 34ms (unchanged)
-src/utils/uniswap/FixedPoint96.sol 2ms (unchanged)
-src/utils/uniswap/FullMath.sol 21ms (unchanged)
-src/utils/uniswap/LiquidityAmounts.sol 41ms (unchanged)
+src/utils/MultiOwnable.sol 45ms (unchanged)
+src/utils/uniswap/BitMath.sol 10ms (unchanged)
+src/utils/uniswap/BytesLib.sol 17ms (unchanged)
+src/utils/uniswap/CustomRevert.sol 41ms (unchanged)
+src/utils/uniswap/FixedPoint96.sol 1ms (unchanged)
+src/utils/uniswap/FullMath.sol 20ms (unchanged)
+src/utils/uniswap/LiquidityAmounts.sol 46ms (unchanged)
 src/utils/uniswap/Path.sol 5ms (unchanged)
 src/utils/uniswap/SafeCast.sol 11ms (unchanged)
-src/utils/uniswap/SqrtPriceMath.sol 63ms (unchanged)
-src/utils/uniswap/TickMath.sol 59ms (unchanged)
+src/utils/uniswap/SqrtPriceMath.sol 64ms (unchanged)
+src/utils/uniswap/TickMath.sol 68ms (unchanged)
 src/utils/uniswap/UnsafeMath.sol 2ms (unchanged)
 src/version/ContractVersionBase.sol 1ms (unchanged)
-src/ZoraFactoryImpl.sol 152ms (unchanged)
-test/AutoSwapper.t.sol 36ms (unchanged)
-test/Coin.t.sol 315ms (unchanged)
-test/CoinDopplerUniV3.t.sol 159ms (unchanged)
-test/CoinUniV4.t.sol 337ms (unchanged)
-test/CreatorCoin.t.sol 141ms (unchanged)
-test/DeploymentHooks.t.sol 99ms (unchanged)
-test/Factory.t.sol 202ms (unchanged)
-test/HooksDeployment.t.sol 29ms (unchanged)
-test/LiquidityMigration.t.sol 87ms (unchanged)
-test/mocks/MockERC20.sol 4ms (unchanged)
-test/MultiOwnable.t.sol 97ms (unchanged)
-test/Upgrades.t.sol 111ms (unchanged)
-test/utils/BaseTest.sol 175ms (unchanged)
-test/utils/ContractAddresses.sol 3ms (unchanged)
-test/utils/DeployedCoinVersionLookup.t.sol 36ms (unchanged)
-test/utils/FeeEstimatorHook.sol 30ms (unchanged)
-test/utils/ProtocolRewards.sol 283ms (unchanged)
-test/utils/ProxyShim.sol 3ms (unchanged)
+src/ZoraFactoryImpl.sol 106ms (unchanged)
+test/AutoSwapper.t.sol 34ms (unchanged)
+test/Coin.t.sol 110ms (unchanged)
+test/CoinUniV4.t.sol 336ms (unchanged)
+test/CreatorCoin.t.sol 130ms (unchanged)
+test/DeploymentHooks.t.sol 66ms (unchanged)
+test/Factory.t.sol 76ms (unchanged)
+test/HooksDeployment.t.sol 25ms (unchanged)
+test/LiquidityMigration.t.sol 155ms (unchanged)
+test/mocks/MockERC20.sol 2ms (unchanged)
+test/MultiOwnable.t.sol 80ms (unchanged)
+test/Upgrades.t.sol 107ms (unchanged)
+test/utils/BaseTest.sol 154ms (unchanged)
+test/utils/ContractAddresses.sol 2ms (unchanged)
+test/utils/DeployedCoinVersionLookup.t.sol 38ms (unchanged)
+test/utils/FeeEstimatorHook.sol 26ms (unchanged)
+test/utils/ProtocolRewards.sol 281ms (unchanged)
+test/utils/ProxyShim.sol 6ms (unchanged)
 script/Deploy.s.sol 3ms (unchanged)
-script/DeployAutoSwapper.s.sol 8ms (unchanged)
-script/DeployDevFactory.s.sol 4ms (unchanged)
-script/DeployPostDeploymentHooks.s.sol 9ms (unchanged)
-script/DeployUpgradeGate.s.sol 5ms (unchanged)
-script/GenerateDeterministicParams.s.sol 11ms (unchanged)
-script/PrintRegisterUpgradePath.s.sol 18ms (unchanged)
+script/DeployAutoSwapper.s.sol 13ms (unchanged)
+script/DeployDevFactory.s.sol 3ms (unchanged)
+script/DeployPostDeploymentHooks.s.sol 2ms (unchanged)
+script/DeployUpgradeGate.s.sol 3ms (unchanged)
+script/GenerateDeterministicParams.s.sol 12ms (unchanged)
+script/PrintRegisterUpgradePath.s.sol 9ms (unchanged)
 script/PrintUpgradeCommand.s.sol 2ms (unchanged)
-script/Simulate.s.sol 16ms (unchanged)
-script/TestBackingCoinSwap.s.sol 34ms (unchanged)
-script/TestV4Swap.s.sol 33ms (unchanged)
-script/UpgradeCoinImpl.sol 6ms (unchanged)
-script/UpgradeFactoryImpl.s.sol 6ms (unchanged)
-script/UpgradeHooks.s.sol 4ms (unchanged)
+script/TestBackingCoinSwap.s.sol 31ms (unchanged)
+script/TestV4Swap.s.sol 30ms (unchanged)
+script/UpgradeCoinImpl.sol 5ms (unchanged)
+script/UpgradeFactoryImpl.s.sol 5ms (unchanged)
+script/UpgradeHooks.s.sol 6ms (unchanged)
 CLI Building entry: package/index.ts
 CLI Using tsconfig: tsconfig.json
 CLI tsup v8.4.0
@@ -198,9 +194,9 @@ script/UpgradeHooks.s.sol 4ms (unchanged)
 CLI Cleaning output folder
 CJS Build start
 ESM Build start
-CJS dist/index.cjs     131.00 KB
-CJS dist/index.cjs.map 232.35 KB
-CJS ⚡️ Build success in 42ms
-ESM dist/index.js     129.58 KB
-ESM dist/index.js.map 232.20 KB
-ESM ⚡️ Build success in 42ms
+ESM dist/index.js     128.58 KB
+ESM dist/index.js.map 229.86 KB
+ESM ⚡️ Build success in 44ms
+CJS dist/index.cjs     130.00 KB
+CJS dist/index.cjs.map 230.01 KB
+CJS ⚡️ Build success in 44ms

package/CHANGELOG.md

@@ -1,5 +1,33 @@
 # @zoralabs/coins
 
+## 2.1.0
+
+### Minor Changes
+
+- dac72691: Remove Uniswap V3 support and refactor coin architecture
+
+  **Removal of V3 Support:**
+
+  - Removed support for creating coins based on Uniswap V3 - only V4 coins are supported
+  - Default coin deployment now creates Uniswap V4 coins when no config is provided (previously created V3)
+  - Removed V3-specific test files and utilities
+  - Updated remaining tests to use V4 deployment methods
+  - Removed V3 configuration functions and encoders
+  - Added revert logic for V3 deployment attempts in factory deploy functions
+
+  **Architecture Refactoring:**
+
+  - Merged BaseCoinV4 functionality into BaseCoin.sol to consolidate Uniswap V4 integration
+  - Combined ICoinV4 interface with ICoin interface to simplify the interface hierarchy
+  - Updated ContentCoin and CreatorCoin to inherit directly from BaseCoin
+  - Removed duplicate files: BaseCoinV4.sol and ICoinV4.sol
+  - Updated all imports and references throughout the codebase
+  - This is an internal refactoring that doesn't change external functionality
+
+### Patch Changes
+
+- deb9175b: Enforce 32 bytes for decoding trade referral address from hook data
+
 ## 2.0.0
 
 ### Major Changes

package/README.md

@@ -2,131 +2,52 @@
 
 A protocol for creating and trading creator and content coins with automatic rewards distribution on top of Uniswap V4 hooks.
 
-## Architecture Overview
+## 📖 Documentation
 
-The Coins protocol consists of several key contracts that work together to enable coin creation, trading, and customization:
+For comprehensive documentation including architecture details, contract specifications, and usage guides, visit:
 
-### Core Contracts
+**[Coins Documentation](https://docs.zora.co/docs/coins)**
 
-#### BaseCoin
+## Quick Start
 
-The abstract base contract that provides core ERC20 functionality with additional features:
+This package contains the core smart contracts for the Zora Coins protocol. For end-user guides and detailed explanations, see the documentation link above.
 
-- **ERC20 with Permit**: Standard token functionality with gasless approvals
-- **Multi-ownership**: Support for multiple owners
-- **Reward Distribution**: Distributes rewards on swaps
-- **Comment System**: Support for on-chain comments via `ICoinComments`
+### Development Setup
 
-#### BaseCoinV4
+1. **Install dependencies**:
 
-Abstract base contract that provides shared Uniswap V4 functionality:
+   ```bash
+   pnpm install
+   ```
 
-- **V4 Pool Manager**: Direct integration with Uniswap V4's singleton pool manager
-- **Pool Configuration**: Flexible pool setup with custom parameters
-- **Hook System**: Customizable hooks for advanced trading logic
-- **Swap Path Management**: Support for multi-hop swaps through `IHasSwapPath`
-- **Liquidity Migration**: Ability to migrate liquidity between hook implementations
+2. **Environment setup**:
 
-#### ContentCoin
+   ```bash
+   cp .env.example .env
+   # Edit .env with your configuration
+   ```
 
-Content coin implementation that inherits from `BaseCoinV4`:
+3. **Build contracts**:
 
-- **Creator Coin Backing**: Always uses the creator's CreatorCoin as the backing currency
-- **Supply**: 1 billion total supply (990M for liquidity pool, 10M creator reward)
-- **Multiple per Creator**: Each creator can have multiple content coins
+   ```bash
+   forge build
+   ```
 
-#### CreatorCoin
+4. **Run tests**:
+   ```bash
+   forge test -vvv
+   ```
 
-Specialized coin implementation for creators (one per creator) that inherits from `BaseCoinV4`:
+### Testing
 
-- **Vesting Schedule**: Built-in token vesting for creator rewards (5-year vesting)
-- **Fixed Currency**: Always uses ZORA token as backing currency
-  - **Address**: `0x1111111111166b7FE7bd91427724B487980aFc69`
-  - **Network**: Base mainnet only (protocol is deployed exclusively on Base)
-- **Supply**: 1 billion total supply (500M for market, 500M for creator vesting)
-- **Single per Creator**: Each creator has exactly one CreatorCoin that backs their content coins
+For individual packages:
 
-#### Coin (V3 Implementation - Legacy)
+- `forge test -vvv` - Run Solidity tests with verbose output
+- `forge test --watch -vvv` - Run tests in watch mode
+- `forge test -vvv --match-test {test_name}` - Run specific test
+- `pnpm test` - Run JavaScript/TypeScript tests
 
-The V3 implementation of coins using Uniswap V3 integration, predating the V4 architecture:
-
-- **Uniswap V3 Integration**: Uses Uniswap V3 factory and swap router for trading
-- **Concentrated Liquidity**: Manages multiple liquidity positions with custom ranges
-- **Currency Flexibility**: Supports any ERC20 token as backing currency (not restricted to ZORA)
-- **Position Management**: Maintains array of `LpPosition` structs for liquidity tracking
-- **Market Rewards**: Distributes rewards from liquidity position fees
-- **V3 vs V4 Differences**: 
-  - V3 uses traditional swap router patterns vs V4's singleton pool manager
-  - V3 requires separate pool deployment vs V4's integrated pool creation
-  - V3 has manual liquidity position management vs V4's hook-based automation
-- **Migration Path**: Existing V3 coins continue to operate but new deployments use V4
-
-#### ZoraFactory (Proxy Contract)
-
-The proxy contract that delegates to ZoraFactoryImpl using the ERC1967 proxy pattern:
-
-- **ERC1967 Proxy**: Standard upgradeable proxy implementation from OpenZeppelin
-- **Immutable Name**: Distinguished by immutable name field (`keccak256("ZoraFactory")`) for verification
-- **Delegation Pattern**: All function calls are delegated to the implementation contract
-- **Upgrade Safety**: Supports safe upgrades through the UUPS pattern in the implementation
-- **Cross-Chain Consistency**: Deterministic deployment ensures same address across chains
-- **Critical Initialization**: Must be initialized in the same transaction as deployment
-  - Proxy deployment and initialization are separate steps for address mining
-  - Failure to initialize leaves the factory in an unusable state
-- **Verification**: Unique bytecode allows proper contract verification on block explorers
-
-#### ZoraFactoryImpl
-
-The main factory contract for deploying coins:
-
-- **Deterministic Deployment**: Uses CREATE2 for predictable addresses when deploying coins
-- **Version Management**: Supports multiple coin implementations
-- **Hook Integration**: Automated hook deployment and configuration
-- **Upgrade Support**: UUPS upgradeable pattern for factory improvements and bug fixes
-
-#### HookUpgradeGate
-
-Manages safe upgrade paths for V4 coin hooks with strict security controls:
-
-- **Upgrade Path Registry**: Maintains `mapping(address => mapping(address => bool))` of allowed upgrades
-- **Multi-Path Registration**: Single upgrade can be registered for multiple base implementations
-- **Owner Control**: Uses Ownable2Step for secure ownership transfers with two-step process
-- **Security Features**:
-  - Only owner can register or remove upgrade paths
-  - Prevents unauthorized hook upgrades that could compromise coins
-  - Whitelist approach ensures only vetted upgrades are allowed
-- **Upgrade Process**:
-  1. Owner registers upgrade path via `registerUpgradePath()`
-  2. Coin creators can then upgrade their hooks using registered paths
-  3. Upgrades can be revoked by owner via `removeUpgradePath()`
-- **Event Logging**: Emits `UpgradeRegistered` and `UpgradeRemoved` events for transparency
-- **Use Cases**: Enables safe migration of coins to new hook implementations without breaking existing functionality
-
-### Hook System
-
-The protocol supports various hooks for customizing coin behavior:
-
-#### BaseZoraV4CoinHook
-
-Immutable base hook contract providing behavior that happens after swaps:
-
-- **Deployment Hooks**: Integrates with coin deployment process for initialization
-- **Trading Hooks**: Hooks into swap events for custom logic execution
-- **Reward Distribution**: Manages reward distribution during trading activities
-- **State Management**: Maintains hook-specific state across transactions
-- **Content Validation**: Ensures proper coin -> liquidity association
-- **Liquidity Migration**: Supports controlled liquidity migration by the creator to a new hook.
-
-## Supply Distribution Summary
-
-| Coin Type       | Total Supply  | Liquidity Pool | Creator Allocation | Vesting Period |
-| --------------- | ------------- | -------------- | ------------------ | -------------- |
-| **ContentCoin** | 1,000,000,000 | 990,000,000    | 10,000,000         | None           |
-| **CreatorCoin** | 1,000,000,000 | 500,000,000    | 500,000,000        | 5 years        |
-
-_All amounts are in tokens with 18 decimals_
-
-## Deployment
+### Deployment
 
 The `ZoraFactory` contract is deployed deterministically using a turnkey account. The deployment process uses a helper contract, [DeterministicDeployerAndCaller](../../packages/shared-contracts/src/deployment/DeterministicDeployerAndCaller.sol).