@zoralabs/coins 1.1.2 → 2.1.0

package/.turbo/turbo-build.log

@@ -1,33 +1,39 @@
 
-> @zoralabs/coins@1.1.2 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@1.1.2 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 244 files with Solc 0.8.28
-Solc 0.8.28 finished in 253.65s
+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 (CoinV4) {
+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,122 +79,113 @@ Warning (2072): Unused local variable.
 ✅ Updated ./package/wagmiGenerated.ts (10 replacements)
 ✨ All files processed successfully!
 
-> @zoralabs/coins@1.1.2 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@1.1.2 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 347ms (unchanged)
-src/Coin.sol 156ms (unchanged)
-src/CoinV4.sol 114ms (unchanged)
-src/CreatorCoin.sol 51ms (unchanged)
-src/deployment/CoinsDeployerBase.sol 211ms (unchanged)
-src/hooks/BaseZoraV4CoinHook.sol 181ms (unchanged)
-src/hooks/ContentCoinHook.sol 8ms (unchanged)
-src/hooks/CreatorCoinHook.sol 6ms (unchanged)
-src/hooks/deployment/BaseCoinDeployHook.sol 13ms (unchanged)
-src/hooks/deployment/BuySupplyWithSwapRouterHook.sol 131ms (unchanged)
-src/hooks/HookUpgradeGate.sol 23ms (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 9ms (unchanged)
+src/interfaces/ICoin.sol 13ms (unchanged)
 src/interfaces/ICoinComments.sol 1ms (unchanged)
-src/interfaces/ICoinDeployHook.sol 2ms (unchanged)
-src/interfaces/ICoinV3.sol 4ms (unchanged)
-src/interfaces/ICoinV4.sol 3ms (unchanged)
+src/interfaces/ICoinDeployHook.sol 1ms (unchanged)
+src/interfaces/ICoinV3.sol 3ms (unchanged)
 src/interfaces/ICreatorCoin.sol 2ms (unchanged)
-src/interfaces/ICreatorCoinHook.sol 1ms (unchanged)
+src/interfaces/ICreatorCoinHook.sol 2ms (unchanged)
 src/interfaces/IDeployedCoinVersionLookup.sol 1ms (unchanged)
 src/interfaces/IDopplerErrors.sol 1ms (unchanged)
-src/interfaces/IERC7572.sol 1ms (unchanged)
+src/interfaces/IERC7572.sol 0ms (unchanged)
 src/interfaces/IHasRewardsRecipients.sol 1ms (unchanged)
-src/interfaces/IHooksUpgradeGate.sol 2ms (unchanged)
-src/interfaces/IMsgSender.sol 2ms (unchanged)
-src/interfaces/INonfungiblePositionManager.sol 5ms (unchanged)
+src/interfaces/IHooksUpgradeGate.sol 1ms (unchanged)
+src/interfaces/IMsgSender.sol 1ms (unchanged)
+src/interfaces/INonfungiblePositionManager.sol 4ms (unchanged)
 src/interfaces/IPoolConfigEncoding.sol 2ms (unchanged)
-src/interfaces/IProtocolRewards.sol 4ms (unchanged)
-src/interfaces/ISwapPathRouter.sol 2ms (unchanged)
-src/interfaces/ISwapRouter.sol 0ms (unchanged)
-src/interfaces/IUniswapV3Factory.sol 4ms (unchanged)
-src/interfaces/IUniswapV3Pool.sol 4ms (unchanged)
-src/interfaces/IUniswapV3SwapCallback.sol 2ms (unchanged)
+src/interfaces/IProtocolRewards.sol 2ms (unchanged)
+src/interfaces/ISwapPathRouter.sol 1ms (unchanged)
+src/interfaces/ISwapRouter.sol 1ms (unchanged)
+src/interfaces/IUniswapV3Factory.sol 5ms (unchanged)
+src/interfaces/IUniswapV3Pool.sol 3ms (unchanged)
+src/interfaces/IUniswapV3SwapCallback.sol 1ms (unchanged)
 src/interfaces/IUpgradeableV4Hook.sol 2ms (unchanged)
-src/interfaces/IWETH.sol 2ms (unchanged)
-src/interfaces/IZoraFactory.sol 7ms (unchanged)
-src/interfaces/IZoraV4CoinHook.sol 8ms (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 83ms (unchanged)
+src/libs/CoinConfigurationVersions.sol 46ms (unchanged)
 src/libs/CoinConstants.sol 4ms (unchanged)
-src/libs/CoinDopplerMultiCurve.sol 105ms (unchanged)
-src/libs/CoinDopplerUniV3.sol 29ms (unchanged)
-src/libs/CoinRewards.sol 118ms (unchanged)
+src/libs/CoinDopplerMultiCurve.sol 103ms (unchanged)
 src/libs/CoinRewardsV4.sol 99ms (unchanged)
-src/libs/CoinSetup.sol 20ms (unchanged)
-src/libs/CoinSetupV3.sol 17ms (unchanged)
+src/libs/CoinSetup.sol 26ms (unchanged)
 src/libs/CreatorCoinConstants.sol 2ms (unchanged)
-src/libs/CreatorCoinRewards.sol 11ms (unchanged)
-src/libs/DopplerMath.sol 81ms (unchanged)
-src/libs/HooksDeployment.sol 95ms (unchanged)
-src/libs/MarketConstants.sol 1ms (unchanged)
+src/libs/CreatorCoinRewards.sol 18ms (unchanged)
+src/libs/DopplerMath.sol 88ms (unchanged)
+src/libs/HooksDeployment.sol 79ms (unchanged)
+src/libs/MarketConstants.sol 2ms (unchanged)
 src/libs/PoolStateReader.sol 6ms (unchanged)
-src/libs/UniV3BuySell.sol 84ms (unchanged)
-src/libs/UniV3Errors.sol 2ms (unchanged)
-src/libs/UniV4SwapHelper.sol 28ms (unchanged)
-src/libs/UniV4SwapToCurrency.sol 56ms (unchanged)
-src/libs/V4Liquidity.sol 148ms (unchanged)
-src/proxy/ZoraFactory.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/PoolState.sol 2ms (unchanged)
-src/utils/AutoSwapper.sol 17ms (unchanged)
-src/utils/DeployedCoinVersionLookup.sol 9ms (unchanged)
-src/utils/MultiOwnable.sol 41ms (unchanged)
-src/utils/uniswap/BitMath.sol 12ms (unchanged)
-src/utils/uniswap/BytesLib.sol 12ms (unchanged)
-src/utils/uniswap/CustomRevert.sol 36ms (unchanged)
-src/utils/uniswap/FixedPoint96.sol 2ms (unchanged)
-src/utils/uniswap/FullMath.sol 21ms (unchanged)
-src/utils/uniswap/LiquidityAmounts.sol 43ms (unchanged)
+src/types/PoolConfiguration.sol 3ms (unchanged)
+src/types/PoolState.sol 1ms (unchanged)
+src/utils/AutoSwapper.sol 20ms (unchanged)
+src/utils/DeployedCoinVersionLookup.sol 4ms (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 66ms (unchanged)
-src/utils/uniswap/TickMath.sol 67ms (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 162ms (unchanged)
-test/AutoSwapper.t.sol 36ms (unchanged)
-test/Coin.t.sol 327ms (unchanged)
-test/CoinDopplerUniV3.t.sol 122ms (unchanged)
-test/CoinUniV4.t.sol 334ms (unchanged)
-test/CreatorCoin.t.sol 149ms (unchanged)
-test/DeploymentHooks.t.sol 102ms (unchanged)
-test/Factory.t.sol 179ms (unchanged)
-test/HooksDeployment.t.sol 28ms (unchanged)
-test/LiquidityMigration.t.sol 91ms (unchanged)
-test/mocks/MockERC20.sol 4ms (unchanged)
-test/MultiOwnable.t.sol 82ms (unchanged)
-test/Upgrades.t.sol 127ms (unchanged)
-test/utils/BaseTest.sol 172ms (unchanged)
-test/utils/ContractAddresses.sol 4ms (unchanged)
-test/utils/DeployedCoinVersionLookup.t.sol 41ms (unchanged)
-test/utils/FeeEstimatorHook.sol 27ms (unchanged)
-test/utils/ProtocolRewards.sol 323ms (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 4ms (unchanged)
-script/DeployAutoSwapper.s.sol 8ms (unchanged)
-script/DeployDevFactory.s.sol 5ms (unchanged)
-script/DeployPostDeploymentHooks.s.sol 4ms (unchanged)
-script/DeployUpgradeGate.s.sol 6ms (unchanged)
-script/GenerateDeterministicParams.s.sol 14ms (unchanged)
-script/PrintRegisterUpgradePath.s.sol 13ms (unchanged)
+script/Deploy.s.sol 3ms (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 12ms (unchanged)
-script/TestBackingCoinSwap.s.sol 38ms (unchanged)
-script/TestV4Swap.s.sol 35ms (unchanged)
+script/TestBackingCoinSwap.s.sol 31ms (unchanged)
+script/TestV4Swap.s.sol 30ms (unchanged)
 script/UpgradeCoinImpl.sol 5ms (unchanged)
-script/UpgradeFactoryImpl.s.sol 8ms (unchanged)
-script/UpgradeHooks.s.sol 4ms (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
@@ -197,9 +194,9 @@ script/UpgradeHooks.s.sol 4ms (unchanged)
 CLI Cleaning output folder
 CJS Build start
 ESM Build start
-CJS dist/index.cjs     130.34 KB
-CJS dist/index.cjs.map 231.16 KB
-CJS ⚡️ Build success in 43ms
-ESM dist/index.js     128.93 KB
-ESM dist/index.js.map 231.01 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,10 +1,60 @@
 # @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
+
+- 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
 

package/README.md

@@ -1,6 +1,53 @@
 # Coins
 
-## Deployment
+A protocol for creating and trading creator and content coins with automatic rewards distribution on top of Uniswap V4 hooks.
+
+## 📖 Documentation
+
+For comprehensive documentation including architecture details, contract specifications, and usage guides, visit:
+
+**[Coins Documentation](https://docs.zora.co/docs/coins)**
+
+## Quick Start
+
+This package contains the core smart contracts for the Zora Coins protocol. For end-user guides and detailed explanations, see the documentation link above.
+
+### Development Setup
+
+1. **Install dependencies**:
+
+   ```bash
+   pnpm install
+   ```
+
+2. **Environment setup**:
+
+   ```bash
+   cp .env.example .env
+   # Edit .env with your configuration
+   ```
+
+3. **Build contracts**:
+
+   ```bash
+   forge build
+   ```
+
+4. **Run tests**:
+   ```bash
+   forge test -vvv
+   ```
+
+### Testing
+
+For individual packages:
+
+- `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
+
+### 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).