@zoralabs/coins 1.1.1 → 2.0.0

package/.turbo/turbo-build.log

@@ -1,18 +1,21 @@
 
-> @zoralabs/coins@1.1.1 build /home/runner/work/zora-protocol-private/zora-protocol-private/packages/coins
+> @zoralabs/coins@2.0.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@1.1.1 wagmi:generate /home/runner/work/zora-protocol-private/zora-protocol-private/packages/coins
+> @zoralabs/coins@2.0.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 244 files with Solc 0.8.28
-Solc 0.8.28 finished in 219.49s
+Compiling 246 files with Solc 0.8.28
+Solc 0.8.28 finished in 226.34s
 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:
     |
-117 |     function deployCoinV4Impl(address zoraV4CoinHook) internal returns (CoinV4) {
+117 |     function deployCoinV4Impl(address zoraV4CoinHook) internal returns (ContentCoin) {
     |                               ^^^^^^^^^^^^^^^^^^^^^^
 
 Warning (5667): Unused function parameter. Remove or comment out the variable name to silence this warning.
@@ -70,122 +73,123 @@ Warning (2072): Unused local variable.
 ✅ Updated ./package/wagmiGenerated.ts (10 replacements)
 ✨ All files processed successfully!
 
-> @zoralabs/coins@1.1.1 copy-abis /home/runner/work/zora-protocol-private/zora-protocol-private/packages/coins
+> @zoralabs/coins@2.0.0 copy-abis /home/runner/work/zora-protocol-private/zora-protocol-private/packages/coins
 > pnpm exec bundle-abis
 
 
-> @zoralabs/coins@1.1.1 prettier:write /home/runner/work/zora-protocol-private/zora-protocol-private/packages/coins
+> @zoralabs/coins@2.0.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 323ms (unchanged)
-src/Coin.sol 140ms (unchanged)
-src/CoinV4.sol 117ms (unchanged)
-src/CreatorCoin.sol 50ms (unchanged)
-src/deployment/CoinsDeployerBase.sol 196ms (unchanged)
-src/hooks/BaseZoraV4CoinHook.sol 179ms (unchanged)
-src/hooks/ContentCoinHook.sol 7ms
-src/hooks/CreatorCoinHook.sol 5ms (unchanged)
-src/hooks/deployment/BaseCoinDeployHook.sol 13ms (unchanged)
-src/hooks/deployment/BuySupplyWithSwapRouterHook.sol 127ms (unchanged)
+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 1ms (unchanged)
+src/interfaces/IAirlock.sol 2ms (unchanged)
 src/interfaces/ICoin.sol 13ms (unchanged)
-src/interfaces/ICoinComments.sol 1ms (unchanged)
+src/interfaces/ICoinComments.sol 2ms (unchanged)
 src/interfaces/ICoinDeployHook.sol 1ms (unchanged)
-src/interfaces/ICoinV3.sol 2ms (unchanged)
+src/interfaces/ICoinV3.sol 3ms (unchanged)
 src/interfaces/ICoinV4.sol 2ms (unchanged)
 src/interfaces/ICreatorCoin.sol 1ms (unchanged)
-src/interfaces/ICreatorCoinHook.sol 2ms (unchanged)
-src/interfaces/IDeployedCoinVersionLookup.sol 3ms (unchanged)
-src/interfaces/IDopplerErrors.sol 1ms (unchanged)
+src/interfaces/ICreatorCoinHook.sol 1ms (unchanged)
+src/interfaces/IDeployedCoinVersionLookup.sol 1ms (unchanged)
+src/interfaces/IDopplerErrors.sol 0ms (unchanged)
 src/interfaces/IERC7572.sol 1ms (unchanged)
 src/interfaces/IHasRewardsRecipients.sol 1ms (unchanged)
 src/interfaces/IHooksUpgradeGate.sol 2ms (unchanged)
 src/interfaces/IMsgSender.sol 1ms (unchanged)
-src/interfaces/INonfungiblePositionManager.sol 5ms (unchanged)
+src/interfaces/INonfungiblePositionManager.sol 8ms (unchanged)
 src/interfaces/IPoolConfigEncoding.sol 2ms (unchanged)
-src/interfaces/IProtocolRewards.sol 7ms (unchanged)
-src/interfaces/ISwapPathRouter.sol 2ms (unchanged)
-src/interfaces/ISwapRouter.sol 1ms (unchanged)
-src/interfaces/IUniswapV3Factory.sol 3ms (unchanged)
-src/interfaces/IUniswapV3Pool.sol 4ms (unchanged)
-src/interfaces/IUniswapV3SwapCallback.sol 1ms (unchanged)
-src/interfaces/IUpgradeableV4Hook.sol 4ms (unchanged)
+src/interfaces/IProtocolRewards.sol 3ms (unchanged)
+src/interfaces/ISwapPathRouter.sol 1ms (unchanged)
+src/interfaces/ISwapRouter.sol 0ms (unchanged)
+src/interfaces/IUniswapV3Factory.sol 2ms (unchanged)
+src/interfaces/IUniswapV3Pool.sol 3ms (unchanged)
+src/interfaces/IUniswapV3SwapCallback.sol 2ms (unchanged)
+src/interfaces/IUpgradeableV4Hook.sol 2ms (unchanged)
 src/interfaces/IWETH.sol 2ms (unchanged)
-src/interfaces/IZoraFactory.sol 7ms (unchanged)
-src/interfaces/IZoraV4CoinHook.sol 6ms (unchanged)
-src/libs/CoinCommon.sol 4ms (unchanged)
-src/libs/CoinConfigurationVersions.sol 61ms (unchanged)
-src/libs/CoinConstants.sol 4ms (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 29ms (unchanged)
-src/libs/CoinRewards.sol 112ms (unchanged)
-src/libs/CoinRewardsV4.sol 98ms (unchanged)
-src/libs/CoinSetup.sol 19ms (unchanged)
-src/libs/CoinSetupV3.sol 17ms (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/libs/CreatorCoinConstants.sol 2ms (unchanged)
-src/libs/CreatorCoinRewards.sol 11ms (unchanged)
-src/libs/DopplerMath.sol 77ms (unchanged)
-src/libs/HooksDeployment.sol 94ms (unchanged)
-src/libs/MarketConstants.sol 1ms (unchanged)
-src/libs/PoolStateReader.sol 5ms (unchanged)
-src/libs/UniV3BuySell.sol 77ms (unchanged)
+src/libs/CreatorCoinRewards.sol 10ms (unchanged)
+src/libs/DopplerMath.sol 88ms (unchanged)
+src/libs/HooksDeployment.sol 85ms (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 50ms (unchanged)
-src/libs/V4Liquidity.sol 133ms (unchanged)
-src/proxy/ZoraFactory.sol 6ms (unchanged)
-src/types/LpPosition.sol 0ms (unchanged)
+src/libs/UniV4SwapToCurrency.sol 52ms (unchanged)
+src/libs/V4Liquidity.sol 136ms (unchanged)
+src/proxy/ZoraFactory.sol 7ms (unchanged)
+src/types/LpPosition.sol 1ms (unchanged)
 src/types/PoolConfiguration.sol 1ms (unchanged)
 src/types/PoolState.sol 1ms (unchanged)
-src/utils/AutoSwapper.sol 16ms (unchanged)
-src/utils/DeployedCoinVersionLookup.sol 7ms (unchanged)
-src/utils/MultiOwnable.sol 37ms (unchanged)
-src/utils/uniswap/BitMath.sol 10ms (unchanged)
-src/utils/uniswap/BytesLib.sol 11ms (unchanged)
-src/utils/uniswap/CustomRevert.sol 37ms (unchanged)
-src/utils/uniswap/FixedPoint96.sol 1ms (unchanged)
+src/utils/AutoSwapper.sol 19ms (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 46ms (unchanged)
-src/utils/uniswap/Path.sol 8ms (unchanged)
+src/utils/uniswap/LiquidityAmounts.sol 41ms (unchanged)
+src/utils/uniswap/Path.sol 5ms (unchanged)
 src/utils/uniswap/SafeCast.sol 11ms (unchanged)
-src/utils/uniswap/SqrtPriceMath.sol 58ms (unchanged)
-src/utils/uniswap/TickMath.sol 58ms (unchanged)
+src/utils/uniswap/SqrtPriceMath.sol 63ms (unchanged)
+src/utils/uniswap/TickMath.sol 59ms (unchanged)
 src/utils/uniswap/UnsafeMath.sol 2ms (unchanged)
 src/version/ContractVersionBase.sol 1ms (unchanged)
-src/ZoraFactoryImpl.sol 150ms (unchanged)
-test/AutoSwapper.t.sol 35ms (unchanged)
-test/Coin.t.sol 313ms (unchanged)
-test/CoinDopplerUniV3.t.sol 115ms (unchanged)
-test/CoinUniV4.t.sol 315ms (unchanged)
-test/CreatorCoin.t.sol 140ms (unchanged)
-test/DeploymentHooks.t.sol 126ms (unchanged)
-test/Factory.t.sol 162ms (unchanged)
-test/HooksDeployment.t.sol 26ms (unchanged)
-test/LiquidityMigration.t.sol 86ms (unchanged)
-test/mocks/MockERC20.sol 3ms (unchanged)
-test/MultiOwnable.t.sol 79ms (unchanged)
-test/Upgrades.t.sol 120ms (unchanged)
-test/utils/BaseTest.sol 167ms (unchanged)
-test/utils/ContractAddresses.sol 2ms (unchanged)
-test/utils/DeployedCoinVersionLookup.t.sol 40ms (unchanged)
-test/utils/FeeEstimatorHook.sol 24ms (unchanged)
-test/utils/ProtocolRewards.sol 287ms (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)
 script/Deploy.s.sol 3ms (unchanged)
-script/DeployAutoSwapper.s.sol 9ms (unchanged)
+script/DeployAutoSwapper.s.sol 8ms (unchanged)
 script/DeployDevFactory.s.sol 4ms (unchanged)
-script/DeployPostDeploymentHooks.s.sol 3ms (unchanged)
+script/DeployPostDeploymentHooks.s.sol 9ms (unchanged)
 script/DeployUpgradeGate.s.sol 5ms (unchanged)
-script/GenerateDeterministicParams.s.sol 14ms (unchanged)
-script/PrintRegisterUpgradePath.s.sol 10ms (unchanged)
+script/GenerateDeterministicParams.s.sol 11ms (unchanged)
+script/PrintRegisterUpgradePath.s.sol 18ms (unchanged)
 script/PrintUpgradeCommand.s.sol 2ms (unchanged)
-script/Simulate.s.sol 10ms (unchanged)
+script/Simulate.s.sol 16ms (unchanged)
 script/TestBackingCoinSwap.s.sol 34ms (unchanged)
-script/TestV4Swap.s.sol 28ms (unchanged)
-script/UpgradeCoinImpl.sol 7ms (unchanged)
+script/TestV4Swap.s.sol 33ms (unchanged)
+script/UpgradeCoinImpl.sol 6ms (unchanged)
 script/UpgradeFactoryImpl.s.sol 6ms (unchanged)
-script/UpgradeHooks.s.sol 3ms (unchanged)
+script/UpgradeHooks.s.sol 4ms (unchanged)
 CLI Building entry: package/index.ts
 CLI Using tsconfig: tsconfig.json
 CLI tsup v8.4.0
@@ -194,9 +198,9 @@ script/UpgradeHooks.s.sol 3ms (unchanged)
 CLI Cleaning output folder
 CJS Build start
 ESM Build start
-ESM dist/index.js     128.93 KB
-ESM dist/index.js.map 231.01 KB
+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
-CJS dist/index.cjs     130.34 KB
-CJS dist/index.cjs.map 231.16 KB
-CJS ⚡️ Build success in 43ms

package/CHANGELOG.md

@@ -1,5 +1,33 @@
 # @zoralabs/coins
 
+## 2.0.0
+
+### Major Changes
+
+- acb9ff94: Move ZoraFactoryImpl to 2-step ownable with same storage slots
+
+  This change updates the factory contract to use Ownable2StepUpgradeable instead of OwnableUpgradeable. The change maintains storage slot compatibility while adding the two-step ownership transfer pattern for enhanced security.
+
+  Key changes:
+
+  - ZoraFactoryImpl now inherits from Ownable2StepUpgradeable
+  - Adds pendingOwner() function
+  - Requires acceptOwnership() call to complete ownership transfers
+  - Maintains storage slot compatibility for upgrades
+
+### Patch Changes
+
+- 65d36dbb: Refactor coinv4 into basecoinv4 and content coin
+
+  This refactoring splits the coinv4 implementation into a base coin contract and content coin contract for better modularity and separation of concerns.
+
+## 1.1.2
+
+### Patch Changes
+
+- 522a7c33: Update LICENSE for coins
+- 5c561b01: Fixed bug where hooks could not receive taken eth for paying out rewards
+
 ## 1.1.1
 
 ### Patch Changes

package/LICENSE

@@ -1,21 +1,90 @@
-MIT License
-
-Copyright (c) 2023 Zora Labs
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+License
+
+All source code specified as: SPDX-Identifier: ZORA-DELAYED-OSL-v1
+follows this license.
+
+Other licenses are specified on a file by file basis 
+
+Definitions:
+"Licensed Work" means the software, code, or content distributed under this License, 
+including any copies or derivative works thereof.
+
+"Licensor" means Zora Labs, Inc., a Delaware corporation.
+
+"Commercial Purpose" means any use that generates, or is intended to generate, revenue, 
+monetary value, or other commercial benefit, whether through fees, subscriptions, token 
+issuance, staking incentives, or other monetization mechanisms.
+
+"Competitive Product" means a Product provided for Commercial Purposes, and provides 
+functionality substantially similar to or substitutable for, in whole or in part, the 
+Licensed Work, and that is made available to third parties directly or indirectly, 
+whether operated independently or as part of a broader offering.
+
+"Product" means any software application, protocol, service, or system that (i) makes 
+the Licensed Work (or any derivative work thereof) available for third-party 
+interaction, directly or indirectly, including but not limited to through interfaces, 
+middleware, aggregators, composable integrations, or smart contract deployment; (ii) 
+uses the Licensed Work (or any derivative work thereof) in a production environment or 
+mainnet context; (iii) integrates or incorporates the Licensed Work as part of a 
+broader software or financial service offering; or (iv) is operated for a Commercial 
+Purpose, whether or not publicly accessible.
+
+"Open Date" means the earlier of: (i) the third anniversary of the first public 
+distribution of the Licensed Work, and (ii) the date specified by the Licensor as the 
+official date the Licensed Work shall become available under the MIT License.
+
+Terms:
+
+The Licensor hereby grants you a non-exclusive, non-transferable, worldwide, 
+royalty-free license to (i) use, copy, modify, and create derivative works of the 
+Licensed Work; (ii) distribute the Licensed Work (or any derivative works thereof), in 
+each of (i) and (ii), solely for purposes other than (a) Commercial Purposes, or (b) as 
+a Competitive Product. You are not granted rights to, and you may not exploit, the 
+Licensed Work for Commercial Purposes or as a Competitive Product. For the avoidance of 
+doubt, deploying modified versions of the Licensed Work that preserve the core 
+functionality or interface of the Licensed Work shall be considered a derivative work 
+and subject to this License. This License governs your use even if you receive the 
+Licensed Work from a third party, whether in its original form or in a derivative or 
+modified form.
+
+You must retain, in all copies and substantial portions of the Licensed Work and in all 
+derivative works, (i) all copyright notices, author credits, and licensing notices 
+included by the Licensor, and (ii) a notice stating, "This software includes original 
+work licensed under the Delayed Open Source License by Zora Labs, Inc."
+
+Your rights under this License terminate immediately for all versions of the Licensed 
+Work if you violate its terms.
+
+THE LICENSED WORK IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR 
+A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT 
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF 
+CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE LICENSED 
+WORK OR THE USE OR OTHER DEALINGS IN THE LICENSED WORK.
+
+Effective on the Open Date, the Licensed Work becomes available under the MIT License 
+(attached hereto as Appendix A).
+
+Contact:
+
+To request written consent for unlicensed uses, please contact: support@zora.co
+
+Appendix A – MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this 
+software and associated documentation files (the "Software"), to deal in the Software 
+without restriction, including without limitation the rights to use, copy, modify, 
+merge, publish, distribute, sublicense, and/or sell copies of the Software, and to 
+permit persons to whom the Software is furnished to do so, subject to the following 
+conditions:
+
+The above copyright notice and this permission notice shall be included in all copies 
+or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, 
+INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A 
+PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT 
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF 
+CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE 
+OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

package/README.md

@@ -1,5 +1,131 @@
 # Coins
 
+A protocol for creating and trading creator and content coins with automatic rewards distribution on top of Uniswap V4 hooks.
+
+## Architecture Overview
+
+The Coins protocol consists of several key contracts that work together to enable coin creation, trading, and customization:
+
+### Core Contracts
+
+#### BaseCoin
+
+The abstract base contract that provides core ERC20 functionality with additional features:
+
+- **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`
+
+#### BaseCoinV4
+
+Abstract base contract that provides shared Uniswap V4 functionality:
+
+- **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
+
+#### ContentCoin
+
+Content coin implementation that inherits from `BaseCoinV4`:
+
+- **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
+
+#### CreatorCoin
+
+Specialized coin implementation for creators (one per creator) that inherits from `BaseCoinV4`:
+
+- **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
+
+#### Coin (V3 Implementation - Legacy)
+
+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
 
 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).