@bananapus/core-v6 0.0.37 → 0.0.38

package/test/ComprehensiveInvariant.t.sol

@@ -1,306 +0,0 @@
-// SPDX-License-Identifier: MIT
-pragma solidity ^0.8.6;
-
-import {StdInvariant} from "forge-std/StdInvariant.sol";
-import {TestBaseWorkflow} from "./helpers/TestBaseWorkflow.sol";
-import {IJBRulesetApprovalHook} from "../src/interfaces/IJBRulesetApprovalHook.sol";
-import {IJBTerminal} from "../src/interfaces/IJBTerminal.sol";
-import {IJBSplitHook} from "../src/interfaces/IJBSplitHook.sol";
-import {IJBToken} from "../src/interfaces/IJBToken.sol";
-import {JBConstants} from "../src/libraries/JBConstants.sol";
-import {JBRulesetMetadataResolver} from "../src/libraries/JBRulesetMetadataResolver.sol";
-import {JBCurrencyAmount} from "../src/structs/JBCurrencyAmount.sol";
-import {JBFundAccessLimitGroup} from "../src/structs/JBFundAccessLimitGroup.sol";
-import {JBRuleset} from "../src/structs/JBRuleset.sol";
-import {JBRulesetConfig} from "../src/structs/JBRulesetConfig.sol";
-import {JBRulesetMetadata} from "../src/structs/JBRulesetMetadata.sol";
-import {JBSplit} from "../src/structs/JBSplit.sol";
-import {JBSplitGroup} from "../src/structs/JBSplitGroup.sol";
-import {JBTerminalConfig} from "../src/structs/JBTerminalConfig.sol";
-import {ComprehensiveHandler} from "./invariants/handlers/ComprehensiveHandler.sol";
-import {JBAccountingContext} from "../src/structs/JBAccountingContext.sol";
-
-/// @notice Comprehensive invariant tests for JB V5 fund conservation.
-/// @dev Tests 8 invariants across 10 operations: pay, cashOut, sendPayouts, addToBalance,
-///      sendReservedTokens, useAllowance, burnTokens, claimCredits, advanceTime, processHeldFees.
-contract ComprehensiveInvariant_Local is StdInvariant, TestBaseWorkflow {
-    using JBRulesetMetadataResolver for JBRuleset;
-
-    ComprehensiveHandler public handler;
-
-    uint256 public projectId;
-    address public projectOwner;
-    address public splitBeneficiary;
-
-    function setUp() public override {
-        super.setUp();
-        projectOwner = multisig();
-        splitBeneficiary = address(0xBEEF);
-
-        // ── Launch fee collector project (#1)
-        // ────────────────────────
-        JBRulesetConfig[] memory feeRulesetConfig = new JBRulesetConfig[](1);
-        feeRulesetConfig[0].mustStartAtOrAfter = 0;
-        feeRulesetConfig[0].duration = 0;
-        feeRulesetConfig[0].weight = 1000e18;
-        feeRulesetConfig[0].weightCutPercent = 0;
-        feeRulesetConfig[0].approvalHook = IJBRulesetApprovalHook(address(0));
-        feeRulesetConfig[0].metadata = JBRulesetMetadata({
-            reservedPercent: 0,
-            cashOutTaxRate: 0,
-            baseCurrency: uint32(uint160(JBConstants.NATIVE_TOKEN)),
-            pausePay: false,
-            pauseCreditTransfers: false,
-            allowOwnerMinting: false,
-            allowSetCustomToken: false,
-            allowTerminalMigration: false,
-            allowSetTerminals: false,
-            ownerMustSendPayouts: false,
-            allowSetController: false,
-            allowAddAccountingContext: true,
-            allowAddPriceFeed: false,
-            holdFees: false,
-            useTotalSurplusForCashOuts: false,
-            useDataHookForPay: false,
-            useDataHookForCashOut: false,
-            dataHook: address(0),
-            metadata: 0
-        });
-        feeRulesetConfig[0].splitGroups = new JBSplitGroup[](0);
-        feeRulesetConfig[0].fundAccessLimitGroups = new JBFundAccessLimitGroup[](0);
-
-        JBTerminalConfig[] memory terminalConfigurations = new JBTerminalConfig[](1);
-        JBAccountingContext[] memory tokensToAccept = new JBAccountingContext[](1);
-        tokensToAccept[0] = JBAccountingContext({
-            token: JBConstants.NATIVE_TOKEN, decimals: 18, currency: uint32(uint160(JBConstants.NATIVE_TOKEN))
-        });
-        terminalConfigurations[0] =
-            JBTerminalConfig({terminal: jbMultiTerminal(), accountingContextsToAccept: tokensToAccept});
-
-        jbController()
-            .launchProjectFor({
-                owner: address(420),
-                projectUri: "feeCollector",
-                rulesetConfigurations: feeRulesetConfig,
-                terminalConfigurations: terminalConfigurations,
-                memo: ""
-            });
-
-        // ── Launch test project (#2): 20% reserved, 30% cashOutTax, holdFees, splits, limits ──
-        JBRulesetConfig[] memory rulesetConfig = new JBRulesetConfig[](1);
-        rulesetConfig[0].mustStartAtOrAfter = 0;
-        rulesetConfig[0].duration = 0;
-        rulesetConfig[0].weight = 1000e18;
-        rulesetConfig[0].weightCutPercent = 0;
-        rulesetConfig[0].approvalHook = IJBRulesetApprovalHook(address(0));
-        rulesetConfig[0].metadata = JBRulesetMetadata({
-            reservedPercent: 2000, // 20%
-            cashOutTaxRate: 3000, // 30%
-            baseCurrency: uint32(uint160(JBConstants.NATIVE_TOKEN)),
-            pausePay: false,
-            pauseCreditTransfers: false,
-            allowOwnerMinting: true,
-            allowSetCustomToken: true,
-            allowTerminalMigration: false,
-            allowSetTerminals: false,
-            ownerMustSendPayouts: false,
-            allowSetController: false,
-            allowAddAccountingContext: true,
-            allowAddPriceFeed: false,
-            holdFees: true,
-            useTotalSurplusForCashOuts: false,
-            useDataHookForPay: false,
-            useDataHookForCashOut: false,
-            dataHook: address(0),
-            metadata: 0
-        });
-
-        // Splits: 50% to splitBeneficiary, 50% to fee project (via projectId=1)
-        JBSplit[] memory splits = new JBSplit[](2);
-        splits[0] = JBSplit({
-            percent: uint32(JBConstants.SPLITS_TOTAL_PERCENT / 2),
-            projectId: 0,
-            beneficiary: payable(splitBeneficiary),
-            preferAddToBalance: false,
-            lockedUntil: 0,
-            hook: IJBSplitHook(address(0))
-        });
-        splits[1] = JBSplit({
-            percent: uint32(JBConstants.SPLITS_TOTAL_PERCENT / 2),
-            projectId: 1,
-            beneficiary: payable(address(0)),
-            preferAddToBalance: true,
-            lockedUntil: 0,
-            hook: IJBSplitHook(address(0))
-        });
-        JBSplitGroup[] memory splitGroups = new JBSplitGroup[](1);
-        splitGroups[0] = JBSplitGroup({groupId: uint256(uint160(JBConstants.NATIVE_TOKEN)), splits: splits});
-        rulesetConfig[0].splitGroups = splitGroups;
-
-        // Fund access limits: 5 ETH payout limit, 3 ETH surplus allowance
-        JBCurrencyAmount[] memory payoutLimits = new JBCurrencyAmount[](1);
-        payoutLimits[0] = JBCurrencyAmount({amount: 5 ether, currency: uint32(uint160(JBConstants.NATIVE_TOKEN))});
-
-        JBCurrencyAmount[] memory surplusAllowances = new JBCurrencyAmount[](1);
-        surplusAllowances[0] = JBCurrencyAmount({amount: 3 ether, currency: uint32(uint160(JBConstants.NATIVE_TOKEN))});
-
-        JBFundAccessLimitGroup[] memory fundAccessLimitGroups = new JBFundAccessLimitGroup[](1);
-        fundAccessLimitGroups[0] = JBFundAccessLimitGroup({
-            terminal: address(jbMultiTerminal()),
-            token: JBConstants.NATIVE_TOKEN,
-            payoutLimits: payoutLimits,
-            surplusAllowances: surplusAllowances
-        });
-        rulesetConfig[0].fundAccessLimitGroups = fundAccessLimitGroups;
-
-        projectId = jbController()
-            .launchProjectFor({
-                owner: projectOwner,
-                projectUri: "testProject",
-                rulesetConfigurations: rulesetConfig,
-                terminalConfigurations: terminalConfigurations,
-                memo: ""
-            });
-
-        // Deploy ERC20 so tokens can be tracked
-        vm.prank(projectOwner);
-        jbController().deployERC20For(projectId, "TestToken", "TT", bytes32(0));
-
-        // Deploy handler
-        handler = new ComprehensiveHandler(
-            jbMultiTerminal(), jbTerminalStore(), jbController(), jbTokens(), projectId, projectOwner
-        );
-
-        // Register all 10 handler operations
-        bytes4[] memory selectors = new bytes4[](10);
-        selectors[0] = ComprehensiveHandler.payProject.selector;
-        selectors[1] = ComprehensiveHandler.cashOutTokens.selector;
-        selectors[2] = ComprehensiveHandler.sendPayouts.selector;
-        selectors[3] = ComprehensiveHandler.addToBalance.selector;
-        selectors[4] = ComprehensiveHandler.sendReservedTokens.selector;
-        selectors[5] = ComprehensiveHandler.useAllowance.selector;
-        selectors[6] = ComprehensiveHandler.burnTokens.selector;
-        selectors[7] = ComprehensiveHandler.claimCredits.selector;
-        selectors[8] = ComprehensiveHandler.advanceTime.selector;
-        selectors[9] = ComprehensiveHandler.processHeldFees.selector;
-
-        targetContract(address(handler));
-        targetSelector(FuzzSelector({addr: address(handler), selectors: selectors}));
-    }
-
-    /// @notice COMP1: Terminal ETH balance >= sum of recorded balances.
-    function invariant_COMP1_terminalBalanceCoversRecordedBalances() public view {
-        uint256 projectBalance =
-            jbTerminalStore().balanceOf(address(jbMultiTerminal()), projectId, JBConstants.NATIVE_TOKEN);
-        uint256 feeProjectBalance = jbTerminalStore().balanceOf(address(jbMultiTerminal()), 1, JBConstants.NATIVE_TOKEN);
-        uint256 actualBalance = address(jbMultiTerminal()).balance;
-
-        assertGe(
-            actualBalance,
-            projectBalance + feeProjectBalance,
-            "COMP1: Terminal ETH balance must be >= sum of recorded project balances"
-        );
-    }
-
-    /// @notice COMP2: totalSupplyOf == creditSupply + erc20Supply.
-    function invariant_COMP2_tokenSupplyConsistency() public view {
-        uint256 totalSupply = jbTokens().totalSupplyOf(projectId);
-        uint256 creditSupply = jbTokens().totalCreditSupplyOf(projectId);
-
-        IJBToken token = jbTokens().tokenOf(projectId);
-        uint256 erc20Supply = 0;
-        if (address(token) != address(0)) {
-            erc20Supply = token.totalSupply();
-        }
-
-        assertEq(totalSupply, creditSupply + erc20Supply, "COMP2: totalSupply must equal creditSupply + erc20Supply");
-    }
-
-    /// @notice COMP3: usedPayoutLimit <= payoutLimit per cycle.
-    function invariant_COMP3_payoutLimitRespected() public view {
-        (JBRuleset memory ruleset,) = jbController().currentRulesetOf(projectId);
-        uint256 usedPayoutLimit = jbTerminalStore()
-            .usedPayoutLimitOf(
-                address(jbMultiTerminal()),
-                projectId,
-                JBConstants.NATIVE_TOKEN,
-                ruleset.cycleNumber,
-                uint32(uint160(JBConstants.NATIVE_TOKEN))
-            );
-
-        // Payout limit is 5 ETH
-        assertLe(usedPayoutLimit, 5 ether, "COMP3: usedPayoutLimit must not exceed configured payout limit");
-    }
-
-    /// @notice COMP4: reclaimableSurplus(halfSupply) <= currentSurplus.
-    function invariant_COMP4_reclaimableSurplusLeqSurplus() public view {
-        uint256 totalSupply = jbTokens().totalSupplyOf(projectId);
-        if (totalSupply == 0) return;
-
-        IJBTerminal[] memory _terminals = new IJBTerminal[](1);
-        _terminals[0] = IJBTerminal(jbMultiTerminal());
-        uint256 surplus = jbTerminalStore()
-            .currentSurplusOf({
-                projectId: projectId,
-                terminals: _terminals,
-                tokens: new address[](0),
-                decimals: 18,
-                currency: uint32(uint160(JBConstants.NATIVE_TOKEN))
-            });
-
-        uint256 halfSupply = totalSupply / 2;
-        if (halfSupply == 0) return;
-
-        uint256 reclaimable = jbTerminalStore()
-            .currentReclaimableSurplusOf({
-                projectId: projectId, cashOutCount: halfSupply, totalSupply: totalSupply, surplus: surplus
-            });
-
-        assertLe(reclaimable, surplus, "COMP4: Reclaimable surplus must not exceed current surplus");
-    }
-
-    /// @notice COMP5: After sendReservedTokens, pending balance == 0.
-    function invariant_COMP5_reservesPendingAfterDistribution() public view {
-        // This is an informational invariant: we verify that the pending balance
-        // can be read without reverting. The actual test is that if
-        // sendReservedTokens was called, pending should have been zeroed.
-        // We can't force a call here, but we check consistency.
-        uint256 pending = jbController().pendingReservedTokenBalanceOf(projectId);
-        // Pending is allowed to be > 0 (tokens accumulate between distributions).
-        // The important thing is that the view function doesn't revert.
-        assertGe(pending, 0, "COMP5: pendingReservedTokenBalance should be readable");
-    }
-
-    /// @notice COMP6: Ghost fund conservation (totalIn >= totalOut + remaining).
-    function invariant_COMP6_ghostFundConservation() public view {
-        uint256 totalIn = handler.ghost_totalPaidIn() + handler.ghost_totalAddedToBalance();
-        uint256 totalOut =
-            handler.ghost_totalCashedOut() + handler.ghost_totalPaidOut() + handler.ghost_totalAllowanceUsed();
-
-        // Fees go to project #1, so total funds are conserved within the terminal
-        assertGe(totalIn, totalOut, "COMP6: Ghost conservation - total funds in must be >= total funds out");
-    }
-
-    /// @notice COMP7: Fee project balance never decreases (monotonically increasing).
-    function invariant_COMP7_feeProjectBalanceMonotonic() public view {
-        assertEq(handler.ghost_feeProjectBalanceDecreased(), 0, "COMP7: Fee project balance must never decrease");
-    }
-
-    /// @notice COMP8: Terminal ETH balance == projectBalance + feeBalance + heldFeeAmounts.
-    /// @dev Held fees are subtracted from the project's recorded balance, so the terminal's
-    ///      actual ETH balance should account for held fees.
-    function invariant_COMP8_exactAccountingWithHeldFees() public view {
-        uint256 projectBalance =
-            jbTerminalStore().balanceOf(address(jbMultiTerminal()), projectId, JBConstants.NATIVE_TOKEN);
-        uint256 feeProjectBalance = jbTerminalStore().balanceOf(address(jbMultiTerminal()), 1, JBConstants.NATIVE_TOKEN);
-        uint256 actualBalance = address(jbMultiTerminal()).balance;
-
-        // The terminal's actual ETH balance should always be >= sum of recorded balances.
-        // The difference accounts for held fees that haven't been processed yet.
-        assertGe(
-            actualBalance,
-            projectBalance + feeProjectBalance,
-            "COMP8: Terminal must hold at least the sum of all recorded balances"
-        );
-    }
-}