@zoralabs/coins 1.1.1 → 2.0.0

package/src/libs/DopplerMath.sol

@@ -1,4 +1,10 @@
-// SPDX-License-Identifier: BUSL-1.1
+// SPDX-License-Identifier: ZORA-DELAYED-OSL-v1
+// This software is licensed under the Zora Delayed Open Source License.
+// Under this license, you may use, copy, modify, and distribute this software for
+// non-commercial purposes only. Commercial use and competitive products are prohibited
+// until the "Open Date" (3 years from first public distribution or earlier at Zora's discretion),
+// at which point this software automatically becomes available under the MIT License.
+// Full license terms available at: https://docs.zora.co/coins/license
 pragma solidity ^0.8.24;
 
 import {IDopplerErrors} from "../interfaces/IDopplerErrors.sol";

package/src/libs/HooksDeployment.sol

@@ -1,4 +1,10 @@
-// SPDX-License-Identifier: MIT
+// SPDX-License-Identifier: ZORA-DELAYED-OSL-v1
+// This software is licensed under the Zora Delayed Open Source License.
+// Under this license, you may use, copy, modify, and distribute this software for
+// non-commercial purposes only. Commercial use and competitive products are prohibited
+// until the "Open Date" (3 years from first public distribution or earlier at Zora's discretion),
+// at which point this software automatically becomes available under the MIT License.
+// Full license terms available at: https://docs.zora.co/coins/license
 pragma solidity ^0.8.23;
 
 import {Hooks} from "@uniswap/v4-core/src/libraries/Hooks.sol";

package/src/libs/PoolStateReader.sol

@@ -1,4 +1,10 @@
-// SPDX-License-Identifier: MIT
+// SPDX-License-Identifier: ZORA-DELAYED-OSL-v1
+// This software is licensed under the Zora Delayed Open Source License.
+// Under this license, you may use, copy, modify, and distribute this software for
+// non-commercial purposes only. Commercial use and competitive products are prohibited
+// until the "Open Date" (3 years from first public distribution or earlier at Zora's discretion),
+// at which point this software automatically becomes available under the MIT License.
+// Full license terms available at: https://docs.zora.co/coins/license
 pragma solidity ^0.8.23;
 
 import {StateLibrary} from "@uniswap/v4-core/src/libraries/StateLibrary.sol";

package/src/libs/UniV4SwapHelper.sol

@@ -1,4 +1,10 @@
-// SPDX-License-Identifier: MIT
+// SPDX-License-Identifier: ZORA-DELAYED-OSL-v1
+// This software is licensed under the Zora Delayed Open Source License.
+// Under this license, you may use, copy, modify, and distribute this software for
+// non-commercial purposes only. Commercial use and competitive products are prohibited
+// until the "Open Date" (3 years from first public distribution or earlier at Zora's discretion),
+// at which point this software automatically becomes available under the MIT License.
+// Full license terms available at: https://docs.zora.co/coins/license
 pragma solidity ^0.8.23;
 
 import {PoolKey} from "@uniswap/v4-core/src/types/PoolKey.sol";

package/src/libs/UniV4SwapToCurrency.sol

@@ -1,4 +1,10 @@
-// SPDX-License-Identifier: MIT
+// SPDX-License-Identifier: ZORA-DELAYED-OSL-v1
+// This software is licensed under the Zora Delayed Open Source License.
+// Under this license, you may use, copy, modify, and distribute this software for
+// non-commercial purposes only. Commercial use and competitive products are prohibited
+// until the "Open Date" (3 years from first public distribution or earlier at Zora's discretion),
+// at which point this software automatically becomes available under the MIT License.
+// Full license terms available at: https://docs.zora.co/coins/license
 pragma solidity ^0.8.23;
 
 import {Currency} from "@uniswap/v4-core/src/types/Currency.sol";

package/src/libs/V4Liquidity.sol

@@ -1,4 +1,10 @@
-// SPDX-License-Identifier: MIT
+// SPDX-License-Identifier: ZORA-DELAYED-OSL-v1
+// This software is licensed under the Zora Delayed Open Source License.
+// Under this license, you may use, copy, modify, and distribute this software for
+// non-commercial purposes only. Commercial use and competitive products are prohibited
+// until the "Open Date" (3 years from first public distribution or earlier at Zora's discretion),
+// at which point this software automatically becomes available under the MIT License.
+// Full license terms available at: https://docs.zora.co/coins/license
 pragma solidity ^0.8.23;
 
 import {TickMath} from "@uniswap/v4-core/src/libraries/TickMath.sol";

package/src/types/PoolConfiguration.sol

@@ -1,4 +1,10 @@
-// SPDX-License-Identifier: MIT
+// SPDX-License-Identifier: ZORA-DELAYED-OSL-v1
+// This software is licensed under the Zora Delayed Open Source License.
+// Under this license, you may use, copy, modify, and distribute this software for
+// non-commercial purposes only. Commercial use and competitive products are prohibited
+// until the "Open Date" (3 years from first public distribution or earlier at Zora's discretion),
+// at which point this software automatically becomes available under the MIT License.
+// Full license terms available at: https://docs.zora.co/coins/license
 pragma solidity ^0.8.23;
 
 /// @notice The configuration of the pool

package/src/utils/AutoSwapper.sol

@@ -1,4 +1,10 @@
-// SPDX-License-Identifier: MIT
+// SPDX-License-Identifier: ZORA-DELAYED-OSL-v1
+// This software is licensed under the Zora Delayed Open Source License.
+// Under this license, you may use, copy, modify, and distribute this software for
+// non-commercial purposes only. Commercial use and competitive products are prohibited
+// until the "Open Date" (3 years from first public distribution or earlier at Zora's discretion),
+// at which point this software automatically becomes available under the MIT License.
+// Full license terms available at: https://docs.zora.co/coins/license
 pragma solidity ^0.8.28;
 
 import {ISwapRouter} from "@zoralabs/shared-contracts/interfaces/uniswap/ISwapRouter.sol";

package/src/version/ContractVersionBase.sol

@@ -9,6 +9,6 @@ import {IVersionedContract} from "@zoralabs/shared-contracts/interfaces/IVersion
 contract ContractVersionBase is IVersionedContract {
     /// @notice The version of the contract
     function contractVersion() external pure override returns (string memory) {
-        return "1.1.1";
+        return "2.0.0";
     }
 }

package/test/CoinUniV4.t.sol

@@ -63,7 +63,7 @@ contract CoinUniV4Test is BaseTest {
         uint256 deadline = block.timestamp + 20;
         router.execute(commands, inputs, deadline);
 
-        feeState = FeeEstimatorHook(address(contentCoinHook)).getFeeState();
+        feeState = FeeEstimatorHook(payable(address(contentCoinHook))).getFeeState();
 
         vm.revertToState(snapshot);
     }
@@ -80,8 +80,8 @@ contract CoinUniV4Test is BaseTest {
         uint256 deadline = block.timestamp + 20;
         router.execute(commands, inputs, deadline);
 
-        delta = FeeEstimatorHook(address(contentCoinHook)).getFeeState().lastDelta;
-        swapParams = FeeEstimatorHook(address(contentCoinHook)).getFeeState().lastSwapParams;
+        delta = FeeEstimatorHook(payable(address(contentCoinHook))).getFeeState().lastDelta;
+        swapParams = FeeEstimatorHook(payable(address(contentCoinHook))).getFeeState().lastSwapParams;
 
         sqrtPriceX96 = PoolStateReader.getSqrtPriceX96(coinV4.getPoolKey(), poolManager);
 
@@ -90,7 +90,7 @@ contract CoinUniV4Test is BaseTest {
 
     function test_setupZeroAddressForPoolManager() public {
         vm.expectRevert(ICoin.AddressZero.selector);
-        new CoinV4({
+        new ContentCoin({
             protocolRewardRecipient_: address(0x1234),
             protocolRewards_: address(0x1234),
             poolManager_: IPoolManager(address(0)),
@@ -100,7 +100,7 @@ contract CoinUniV4Test is BaseTest {
 
     // function test_setupZeroAddressForHooks() public {
     //     vm.expectRevert(ICoin.AddressZero.selector);
-    //     new CoinV4({
+    //     new ContentCoin({
     //         protocolRewardRecipient_: address(0x1234),
     //         protocolRewards_: address(0x1234),
     //         poolManager_: IPoolManager(address(0x1234)),
@@ -293,6 +293,62 @@ contract CoinUniV4Test is BaseTest {
         assertApproxEqAbs(mockERC20A.balanceOf(coinV4.protocolRewardRecipient()), totalRewards.protocol, 10, "protocol reward currency");
     }
 
+    function test_distributesMarketRewardsInEth() public {
+        uint64 amountIn = 0.1 ether;
+
+        // Use address(0) as currency to price the coin in ETH
+        address currency = address(0);
+        bytes32 salt = keccak256(abi.encodePacked("eth-rewards-test"));
+        _deployV4Coin(currency, address(0), salt);
+
+        address trader = makeAddr("trader");
+
+        // Give trader ETH
+        vm.deal(trader, amountIn);
+
+        // Record initial ETH balance of payout recipient
+        uint256 initialPayoutBalance = coinV4.payoutRecipient().balance;
+
+        // Swap ETH for coin
+        _swapSomeCurrencyForCoin(coinV4, currency, amountIn, trader);
+
+        // Verify that rewards were paid out in ETH
+        assertGt(coinV4.payoutRecipient().balance, initialPayoutBalance, "backing reward should be paid in ETH");
+    }
+
+    function test_canSwapEthForCoin(uint128 amountIn) public {
+        vm.assume(amountIn > 0.00001 ether);
+        vm.assume(amountIn < 1 ether);
+
+        // Use address(0) as currency to price the coin in ETH
+        address currency = address(0);
+        bytes32 salt = keccak256(abi.encodePacked("eth-coin-test"));
+        _deployV4Coin(currency, address(0), salt);
+
+        address trader = makeAddr("trader");
+
+        // Give trader ETH
+        vm.deal(trader, amountIn);
+
+        uint256 initialEthBalance = trader.balance;
+
+        // Swap ETH for coin
+        _swapSomeCurrencyForCoin(coinV4, currency, amountIn, trader);
+
+        // Verify the swap worked
+        assertEq(trader.balance, initialEthBalance - amountIn, "trader should have spent ETH");
+        assertGt(coinV4.balanceOf(trader), 0, "trader should have received coin");
+
+        // Now swap some coin back for ETH
+        uint128 coinBalance = uint128(coinV4.balanceOf(trader));
+
+        _swapSomeCoinForCurrency(coinV4, currency, coinBalance, trader);
+
+        // Verify the reverse swap worked
+        assertEq(coinV4.balanceOf(trader), 0, "trader should have no coins left");
+        assertGt(trader.balance, 0, "trader should have received ETH back");
+    }
+
     function test_swap_emitsCoinMarketRewardsV4(uint64 amountIn) public {
         vm.assume(amountIn > 0.00001 ether);
         address currency = address(mockERC20A);

package/test/Factory.t.sol

@@ -29,6 +29,47 @@ contract FactoryTest is BaseTest {
         assertEq(ZoraFactoryImpl(address(factory)).owner(), initialOwner);
     }
 
+    function test_ownable2Step() public {
+        // old current impl
+        assertEq(ZoraFactoryImpl(address(factory)).owner(), users.factoryOwner);
+
+        // 1st ensure owner slot is set at expected address
+
+        bytes32 ownableSlot = hex"9016d09d72d40fdae2fd8ceac6b6234c7706214fd39c1cd1e609a0528c199300";
+        bytes32 ownable2StepSlot = hex"237e158222e3e6968b72b9db0d8043aacf074ad9f650f0d1606b4d82ee432c00";
+
+        address ownerAddress = address(uint160(uint256(vm.load(address(factory), ownableSlot))));
+        assertEq(ownerAddress, users.factoryOwner);
+
+        assertEq(ZoraFactoryImpl(address(factory)).pendingOwner(), address(0));
+
+        address newFactoryImpl = address(
+            new ZoraFactoryImpl(address(coinV3Impl), address(coinV4Impl), address(creatorCoinImpl), address(contentCoinHook), address(creatorCoinHook))
+        );
+
+        // Upgrade to current / new impl
+        vm.prank(users.factoryOwner);
+        ZoraFactoryImpl(address(factory)).upgradeToAndCall(newFactoryImpl, "");
+
+        // 2nd ensure owner is read from correct slot
+        assertEq(ZoraFactoryImpl(address(factory)).owner(), users.factoryOwner);
+
+        address newOwner = makeAddr("newOwner");
+
+        // 3rd ensure pending owner is set correctly
+        vm.prank(users.factoryOwner);
+        ZoraFactoryImpl(address(factory)).transferOwnership(newOwner);
+        assertEq(ZoraFactoryImpl(address(factory)).pendingOwner(), newOwner);
+
+        address ownerAddress2Step = address(uint160(uint256(vm.load(address(factory), ownable2StepSlot))));
+        assertEq(ownerAddress2Step, newOwner);
+
+        // 4th ensure owner is set correctly
+        vm.prank(newOwner);
+        ZoraFactoryImpl(address(factory)).acceptOwnership();
+        assertEq(ZoraFactoryImpl(address(factory)).owner(), newOwner);
+    }
+
     function test_deploy_no_eth() public {
         address[] memory owners = new address[](1);
         owners[0] = users.creator;

package/test/Upgrades.t.sol

@@ -21,7 +21,7 @@ import {HooksDeployment} from "../src/libs/HooksDeployment.sol";
 import {IHooks} from "@uniswap/v4-core/src/interfaces/IHooks.sol";
 import {Ownable} from "@openzeppelin/contracts/access/Ownable.sol";
 import {MultiOwnable} from "../src/utils/MultiOwnable.sol";
-import {CoinV4} from "../src/CoinV4.sol";
+import {ContentCoin} from "../src/ContentCoin.sol";
 import {UniV4SwapHelper} from "../src/libs/UniV4SwapHelper.sol";
 import {StateLibrary} from "@uniswap/v4-core/src/libraries/StateLibrary.sol";
 import {IZoraV4CoinHook} from "../src/interfaces/IZoraV4CoinHook.sol";
@@ -225,22 +225,22 @@ contract UpgradesTest is BaseTest, CoinsDeployerBase {
     }
 
     function test_canUpgradeBrokenContentCoinAndSwap() public {
-        vm.createSelectFork("base", 31835069);
+        vm.createSelectFork("base", 32613149);
 
         address trader = 0xf69fEc6d858c77e969509843852178bd24CAd2B6;
 
-        address contentCoin = 0x4E93A01c90f812284F71291a8d1415a904957156;
+        address contentCoin = 0xB9799C839818bF50240CE683363D00c43a2E23b8;
 
         address creatorCoin = ICoinV4(contentCoin).currency();
 
-        address existingHook = 0xd3D133469ADC85e01A4887404D8AC12d630e9040;
-
-        uint256 amountIn = IERC20(creatorCoin).balanceOf(trader);
+        uint256 amountIn = 0.000111 ether;
 
         bytes memory creationCode = HooksDeployment.contentCoinCreationCode(address(poolManager), coinVersionLookup, new address[](0), upgradeGate);
 
         (IHooks newHook, ) = HooksDeployment.deployHookWithExistingOrNewSalt(address(this), creationCode, bytes32(0));
 
+        address existingHook = address(ICoinV4(contentCoin).hooks());
+
         address[] memory baseImpls = new address[](1);
         baseImpls[0] = existingHook;
 
@@ -248,7 +248,7 @@ contract UpgradesTest is BaseTest, CoinsDeployerBase {
         IHooksUpgradeGate(upgradeGate).registerUpgradePath(baseImpls, address(newHook));
 
         vm.prank(MultiOwnable(contentCoin).owners()[0]);
-        CoinV4(contentCoin).migrateLiquidity(address(newHook), "");
+        ContentCoin(contentCoin).migrateLiquidity(address(newHook), "");
 
         // do some swaps to test out
         _swapSomeCurrencyForCoin(ICoinV4(contentCoin), creatorCoin, uint128(amountIn), trader);
@@ -305,7 +305,7 @@ contract UpgradesTest is BaseTest, CoinsDeployerBase {
         uint160 beforePrice = PoolStateReader.getSqrtPriceX96(creatorCoin.getPoolKey(), poolManager);
 
         vm.prank(MultiOwnable(address(creatorCoin)).owners()[0]);
-        CoinV4(address(creatorCoin)).migrateLiquidity(address(newHook), "");
+        ContentCoin(address(creatorCoin)).migrateLiquidity(address(newHook), "");
 
         // get liquidity of original positions after migration
         uint128[] memory liquidityOfPositionsAfterMigration = getLiquidityForPositions(beforeKey, beforePositions);

package/test/utils/BaseTest.sol

@@ -13,7 +13,7 @@ import {IZoraFactory} from "../../src/interfaces/IZoraFactory.sol";
 import {ZoraFactoryImpl} from "../../src/ZoraFactoryImpl.sol";
 import {ZoraFactory} from "../../src/proxy/ZoraFactory.sol";
 import {Coin} from "../../src/Coin.sol";
-import {CoinV4} from "../../src/CoinV4.sol";
+import {ContentCoin} from "../../src/ContentCoin.sol";
 import {MultiOwnable} from "../../src/utils/MultiOwnable.sol";
 import {ICoin} from "../../src/interfaces/ICoin.sol";
 import {IERC7572} from "../../src/interfaces/IERC7572.sol";
@@ -75,14 +75,14 @@ contract BaseTest is Test, ContractAddresses {
     IUniversalRouter internal router;
     IPoolManager internal poolManager;
     IV4Quoter internal quoter;
-    CoinV4 internal coinV4;
+    ContentCoin internal coinV4;
 
     ISwapRouter internal swapRouter;
     IAirlock internal airlock;
     Users internal users;
 
     Coin internal coinV3Impl;
-    CoinV4 internal coinV4Impl;
+    ContentCoin internal coinV4Impl;
     CreatorCoin internal creatorCoinImpl;
     ZoraFactoryImpl internal factoryImpl;
     IZoraFactory internal factory;
@@ -157,7 +157,7 @@ contract BaseTest is Test, ContractAddresses {
             salt
         );
 
-        coinV4 = CoinV4(payable(coinAddress));
+        coinV4 = ContentCoin(payable(coinAddress));
         return coinV4;
     }
 
@@ -206,11 +206,15 @@ contract BaseTest is Test, ContractAddresses {
         );
 
         vm.startPrank(trader);
-        UniV4SwapHelper.approveTokenWithPermit2(permit2, address(router), currency, amountIn, uint48(block.timestamp + 1 days));
+        if (currency != address(0)) {
+            UniV4SwapHelper.approveTokenWithPermit2(permit2, address(router), currency, amountIn, uint48(block.timestamp + 1 days));
+        }
+
+        uint256 value = currency == address(0) ? amountIn : 0;
 
         // Execute the swap
         uint256 deadline = block.timestamp + 20;
-        router.execute(commands, inputs, deadline);
+        router.execute{value: value}(commands, inputs, deadline);
 
         vm.stopPrank();
     }
@@ -269,18 +273,22 @@ contract BaseTest is Test, ContractAddresses {
         (bytes32 contentCoinSalt, bytes32 creatorCoinSalt) = getSalts(trustedMessageSenders);
 
         contentCoinHook = ContentCoinHook(
-            address(
-                HooksDeployment.deployHookWithSalt(
-                    HooksDeployment.contentCoinCreationCode(V4_POOL_MANAGER, address(factory), trustedMessageSenders, address(hookUpgradeGate)),
-                    contentCoinSalt
+            payable(
+                address(
+                    HooksDeployment.deployHookWithSalt(
+                        HooksDeployment.contentCoinCreationCode(V4_POOL_MANAGER, address(factory), trustedMessageSenders, address(hookUpgradeGate)),
+                        contentCoinSalt
+                    )
                 )
             )
         );
         creatorCoinHook = CreatorCoinHook(
-            address(
-                HooksDeployment.deployHookWithSalt(
-                    HooksDeployment.creatorCoinHookCreationCode(V4_POOL_MANAGER, address(factory), trustedMessageSenders, address(hookUpgradeGate)),
-                    creatorCoinSalt
+            payable(
+                address(
+                    HooksDeployment.deployHookWithSalt(
+                        HooksDeployment.creatorCoinHookCreationCode(V4_POOL_MANAGER, address(factory), trustedMessageSenders, address(hookUpgradeGate)),
+                        creatorCoinSalt
+                    )
                 )
             )
         );
@@ -324,7 +332,7 @@ contract BaseTest is Test, ContractAddresses {
 
         _deployHooks();
 
-        coinV4Impl = new CoinV4(users.feeRecipient, address(protocolRewards), IPoolManager(V4_POOL_MANAGER), DOPPLER_AIRLOCK);
+        coinV4Impl = new ContentCoin(users.feeRecipient, address(protocolRewards), IPoolManager(V4_POOL_MANAGER), DOPPLER_AIRLOCK);
 
         creatorCoinImpl = new CreatorCoin(users.feeRecipient, address(protocolRewards), IPoolManager(V4_POOL_MANAGER), DOPPLER_AIRLOCK);
 

package/wagmi.config.ts

@@ -10,7 +10,7 @@ export default defineConfig({
       },
       include: [
         "Coin",
-        "CoinV4",
+        "ContentCoin",
         "CreatorCoin",
         "ZoraFactoryImpl",
         "IUniswapV3Pool",