@zoralabs/coins 2.1.2 → 2.2.1

package/test/utils/RewardTestHelpers.sol

@@ -0,0 +1,106 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.13;
+
+import {CoinRewardsV4} from "../../src/libs/CoinRewardsV4.sol";
+import {FeeEstimatorHook} from "./FeeEstimatorHook.sol";
+import {CoinConstants} from "../../src/libs/CoinConstants.sol";
+import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
+import {Vm} from "forge-std/Vm.sol";
+
+// Shared struct to track balance changes for reward recipients
+struct RewardBalances {
+    uint256 creator;
+    uint256 platformReferrer;
+    uint256 tradeReferrer;
+    uint256 protocol;
+    uint256 doppler;
+}
+
+library RewardTestHelpers {
+    Vm private constant vm = Vm(0x7109709ECfa91a80626fF3989D68f67F5b1DD12D);
+
+    // Helper function to calculate reward based on BPS
+    function calculateReward(uint256 total, uint256 bps) internal pure returns (uint256) {
+        return (total * bps) / 10_000;
+    }
+
+    function calculateExpectedRewards(
+        uint256 marketRewards,
+        bool hasPlatformReferrer,
+        bool hasTradeReferrer
+    ) internal pure returns (RewardBalances memory rewards) {
+        rewards.creator = calculateReward(marketRewards, CoinRewardsV4.CREATOR_REWARD_BPS);
+        rewards.platformReferrer = hasPlatformReferrer ? calculateReward(marketRewards, CoinRewardsV4.CREATE_REFERRAL_REWARD_BPS) : 0;
+        rewards.tradeReferrer = hasTradeReferrer ? calculateReward(marketRewards, CoinRewardsV4.TRADE_REFERRAL_REWARD_BPS) : 0;
+        rewards.doppler = calculateReward(marketRewards, CoinRewardsV4.DOPPLER_REWARD_BPS);
+        rewards.protocol = marketRewards - rewards.creator - rewards.platformReferrer - rewards.tradeReferrer - rewards.doppler;
+    }
+
+    // Helper function to assert reward distributions match expected RewardBalances
+    function assertRewardsApproxEqRel(RewardBalances memory actual, RewardBalances memory expected) internal pure {
+        vm.assertApproxEqRel(actual.creator, expected.creator, 0.25e18, "Creator reward amount");
+        vm.assertApproxEqRel(actual.platformReferrer, expected.platformReferrer, 0.25e18, "Platform referrer reward amount");
+        vm.assertApproxEqRel(actual.tradeReferrer, expected.tradeReferrer, 0.25e18, "Trade referrer reward amount");
+        vm.assertApproxEqRel(actual.doppler, expected.doppler, 0.25e18, "Doppler reward amount");
+        vm.assertApproxEqRel(actual.protocol, expected.protocol, 0.25e18, "Protocol reward amount");
+    }
+
+    // Helper function to assert with higher tolerance for complex conversions
+    function assertRewardsApproxEqRelWithTolerance(RewardBalances memory actual, RewardBalances memory expected, uint256 tolerance) internal pure {
+        vm.assertApproxEqRel(actual.creator, expected.creator, tolerance, "Creator reward amount");
+        vm.assertApproxEqRel(actual.platformReferrer, expected.platformReferrer, tolerance, "Platform referrer reward amount");
+        vm.assertApproxEqRel(actual.tradeReferrer, expected.tradeReferrer, tolerance, "Trade referrer reward amount");
+        vm.assertApproxEqRel(actual.doppler, expected.doppler, tolerance, "Doppler reward amount");
+        vm.assertApproxEqRel(actual.protocol, expected.protocol, tolerance, "Protocol reward amount");
+    }
+
+    // Generic function to record token balances for all reward recipients
+    function recordBalances(
+        IERC20 token,
+        address creator,
+        address platformReferrer,
+        address tradeReferrer,
+        address protocolRecipient,
+        address dopplerRecipient
+    ) internal view returns (RewardBalances memory balances) {
+        balances.creator = token.balanceOf(creator);
+        balances.platformReferrer = token.balanceOf(platformReferrer);
+        balances.tradeReferrer = token.balanceOf(tradeReferrer);
+        balances.protocol = token.balanceOf(protocolRecipient);
+        balances.doppler = token.balanceOf(dopplerRecipient);
+    }
+
+    // Helper function to calculate reward deltas between two balance snapshots
+    function calculateRewardDeltas(
+        RewardBalances memory initialBalances,
+        RewardBalances memory finalBalances
+    ) internal pure returns (RewardBalances memory deltas) {
+        deltas.creator = finalBalances.creator - initialBalances.creator;
+        deltas.platformReferrer = finalBalances.platformReferrer - initialBalances.platformReferrer;
+        deltas.tradeReferrer = finalBalances.tradeReferrer - initialBalances.tradeReferrer;
+        deltas.protocol = finalBalances.protocol - initialBalances.protocol;
+        deltas.doppler = finalBalances.doppler - initialBalances.doppler;
+    }
+
+    // Helper function to sum total rewards
+    function getTotalRewards(RewardBalances memory rewards) internal pure returns (uint256) {
+        return rewards.creator + rewards.platformReferrer + rewards.tradeReferrer + rewards.protocol + rewards.doppler;
+    }
+
+    // Helper function to calculate reward deltas after trade for any token
+    function calculateTokenRewardDeltas(
+        RewardBalances memory initialBalances,
+        IERC20 token,
+        address creator,
+        address platformReferrer,
+        address tradeReferrer,
+        address protocolRecipient,
+        address dopplerRecipient
+    ) internal view returns (RewardBalances memory deltas) {
+        deltas.creator = token.balanceOf(creator) - initialBalances.creator;
+        deltas.platformReferrer = token.balanceOf(platformReferrer) - initialBalances.platformReferrer;
+        deltas.tradeReferrer = token.balanceOf(tradeReferrer) - initialBalances.tradeReferrer;
+        deltas.protocol = token.balanceOf(protocolRecipient) - initialBalances.protocol;
+        deltas.doppler = token.balanceOf(dopplerRecipient) - initialBalances.doppler;
+    }
+}

package/.turbo/turbo-build.log

@@ -1,199 +0,0 @@
-
-> @zoralabs/coins@2.1.2 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.1.2 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 236 files with Solc 0.8.28
-Solc 0.8.28 finished in 195.15s
-Compiler run successful with warnings:
-Warning (5667): Unused function parameter. Remove or comment out the variable name to silence this warning.
-   --> src/ZoraFactoryImpl.sol:214:9:
-    |
-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:114:36:
-    |
-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:273:84:
-    |
-273 |     function deployDevFactory(CoinsDeployment memory deployment) internal returns (ZoraFactory devFactory) {
-    |                                                                                    ^^^^^^^^^^^^^^^^^^^^^^
-
-Warning (2072): Unused local variable.
-   --> script/TestBackingCoinSwap.s.sol:107:9:
-    |
-107 |         address tradeReferral = 0xC077e4cC02fa01A5b7fAca1acE9BBe9f5ac5Af9F;
-    |         ^^^^^^^^^^^^^^^^^^^^^
-
-Warning (2072): Unused local variable.
-  --> script/TestV4Swap.s.sol:99:9:
-   |
-99 |         address createReferral = 0xC077e4cC02fa01A5b7fAca1acE9BBe9f5ac5Af9F;
-   |         ^^^^^^^^^^^^^^^^^^^^^^
-
-Warning (2072): Unused local variable.
-   --> test/CoinUniV4.t.sol:164:9:
-    |
-164 |         uint128 newFeeCurrency = isCoinToken0 ? newFeeState.fees1 : newFeeState.fees0;
-    |         ^^^^^^^^^^^^^^^^^^^^^^
-
-Warning (2072): Unused local variable.
-   --> test/LiquidityMigration.t.sol:188:9:
-    |
-188 |         address originalHook = address(contentCoinHook);
-    |         ^^^^^^^^^^^^^^^^^^^^
-
-Warning (2072): Unused local variable.
-   --> test/LiquidityMigration.t.sol:210:9:
-    |
-210 |         PoolKey memory poolKey = coinV4.getPoolKey();
-    |         ^^^^^^^^^^^^^^^^^^^^^^
-
-- 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.1.2 copy-abis /home/runner/work/zora-protocol-private/zora-protocol-private/packages/coins
-> pnpm exec bundle-abis
-
-
-> @zoralabs/coins@2.1.2 prettier:write /home/runner/work/zora-protocol-private/zora-protocol-private/packages/coins
-> prettier --write 'src/**/*.sol' 'test/**/*.sol' 'script/**/*.sol'
-
-src/BaseCoin.sol 440ms (unchanged)
-src/ContentCoin.sol 31ms (unchanged)
-src/CreatorCoin.sol 61ms (unchanged)
-src/deployment/CoinsDeployerBase.sol 222ms (unchanged)
-src/hooks/BaseZoraV4CoinHook.sol 179ms (unchanged)
-src/hooks/ContentCoinHook.sol 7ms (unchanged)
-src/hooks/CreatorCoinHook.sol 8ms (unchanged)
-src/hooks/deployment/BaseCoinDeployHook.sol 16ms (unchanged)
-src/hooks/deployment/BuySupplyWithSwapRouterHook.sol 130ms (unchanged)
-src/hooks/HookUpgradeGate.sol 25ms (unchanged)
-src/interfaces/IAirlock.sol 1ms (unchanged)
-src/interfaces/ICoin.sol 16ms (unchanged)
-src/interfaces/ICoinComments.sol 1ms (unchanged)
-src/interfaces/ICoinDeployHook.sol 1ms (unchanged)
-src/interfaces/ICoinV3.sol 2ms (unchanged)
-src/interfaces/ICreatorCoin.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/IPoolConfigEncoding.sol 1ms (unchanged)
-src/interfaces/IProtocolRewards.sol 2ms (unchanged)
-src/interfaces/ISwapPathRouter.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 1ms (unchanged)
-src/interfaces/IUpgradeableV4Hook.sol 2ms (unchanged)
-src/interfaces/IWETH.sol 2ms (unchanged)
-src/interfaces/IZoraFactory.sol 11ms (unchanged)
-src/interfaces/IZoraV4CoinHook.sol 11ms (unchanged)
-src/libs/CoinCommon.sol 5ms (unchanged)
-src/libs/CoinConfigurationVersions.sol 48ms (unchanged)
-src/libs/CoinConstants.sol 5ms (unchanged)
-src/libs/CoinDopplerMultiCurve.sol 110ms (unchanged)
-src/libs/CoinRewardsV4.sol 103ms (unchanged)
-src/libs/CoinSetup.sol 29ms (unchanged)
-src/libs/CreatorCoinConstants.sol 3ms (unchanged)
-src/libs/CreatorCoinRewards.sol 22ms (unchanged)
-src/libs/DopplerMath.sol 93ms (unchanged)
-src/libs/HooksDeployment.sol 86ms (unchanged)
-src/libs/MarketConstants.sol 1ms (unchanged)
-src/libs/PoolStateReader.sol 6ms (unchanged)
-src/libs/UniV4SwapHelper.sol 29ms (unchanged)
-src/libs/UniV4SwapToCurrency.sol 50ms (unchanged)
-src/libs/V4Liquidity.sol 138ms (unchanged)
-src/proxy/ZoraFactory.sol 6ms (unchanged)
-src/types/LpPosition.sol 1ms (unchanged)
-src/types/PoolConfiguration.sol 1ms (unchanged)
-src/types/PoolState.sol 2ms (unchanged)
-src/utils/AutoSwapper.sol 20ms (unchanged)
-src/utils/DeployedCoinVersionLookup.sol 5ms (unchanged)
-src/utils/MultiOwnable.sol 46ms (unchanged)
-src/utils/uniswap/BitMath.sol 10ms (unchanged)
-src/utils/uniswap/BytesLib.sol 12ms (unchanged)
-src/utils/uniswap/CustomRevert.sol 43ms (unchanged)
-src/utils/uniswap/FixedPoint96.sol 1ms (unchanged)
-src/utils/uniswap/FullMath.sol 20ms (unchanged)
-src/utils/uniswap/LiquidityAmounts.sol 47ms (unchanged)
-src/utils/uniswap/Path.sol 5ms (unchanged)
-src/utils/uniswap/SafeCast.sol 11ms (unchanged)
-src/utils/uniswap/SqrtPriceMath.sol 67ms (unchanged)
-src/utils/uniswap/TickMath.sol 66ms (unchanged)
-src/utils/uniswap/UnsafeMath.sol 3ms (unchanged)
-src/version/ContractVersionBase.sol 1ms (unchanged)
-src/ZoraFactoryImpl.sol 109ms (unchanged)
-test/AutoSwapper.t.sol 35ms (unchanged)
-test/Coin.t.sol 114ms (unchanged)
-test/CoinUniV4.t.sol 354ms (unchanged)
-test/CreatorCoin.t.sol 133ms (unchanged)
-test/DeploymentHooks.t.sol 68ms (unchanged)
-test/Factory.t.sol 80ms (unchanged)
-test/HooksDeployment.t.sol 27ms (unchanged)
-test/LiquidityMigration.t.sol 162ms (unchanged)
-test/mocks/MockERC20.sol 3ms (unchanged)
-test/MultiOwnable.t.sol 84ms (unchanged)
-test/Upgrades.t.sol 110ms (unchanged)
-test/utils/BaseTest.sol 159ms (unchanged)
-test/utils/ContractAddresses.sol 3ms (unchanged)
-test/utils/DeployedCoinVersionLookup.t.sol 48ms (unchanged)
-test/utils/FeeEstimatorHook.sol 28ms (unchanged)
-test/utils/ProtocolRewards.sol 319ms (unchanged)
-test/utils/ProxyShim.sol 4ms (unchanged)
-script/Deploy.s.sol 3ms (unchanged)
-script/DeployAutoSwapper.s.sol 12ms (unchanged)
-script/DeployDevFactory.s.sol 2ms (unchanged)
-script/DeployPostDeploymentHooks.s.sol 2ms (unchanged)
-script/DeployUpgradeGate.s.sol 3ms (unchanged)
-script/GenerateDeterministicParams.s.sol 11ms (unchanged)
-script/PrintRegisterUpgradePath.s.sol 9ms (unchanged)
-script/PrintUpgradeCommand.s.sol 2ms (unchanged)
-script/TestBackingCoinSwap.s.sol 30ms (unchanged)
-script/TestV4Swap.s.sol 29ms (unchanged)
-script/UpgradeCoinImpl.sol 6ms (unchanged)
-script/UpgradeFactoryImpl.s.sol 5ms (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     128.58 KB
-ESM dist/index.js.map 229.86 KB
-ESM ⚡️ Build success in 41ms
-CJS dist/index.cjs     130.00 KB
-CJS dist/index.cjs.map 230.01 KB
-CJS ⚡️ Build success in 41ms