@bananapus/core-v6 0.0.15 → 0.0.17

package/test/units/static/JBTerminalStore/TestRecordCashOutsFor.sol

@@ -1,7 +1,26 @@
 // SPDX-License-Identifier: MIT
 pragma solidity 0.8.26;
 
-import /* {*} from */ "../../../helpers/TestBaseWorkflow.sol";
+import {JBTerminalStore} from "../../../../src/JBTerminalStore.sol";
+import {IJBCashOutHook} from "../../../../src/interfaces/IJBCashOutHook.sol";
+import {IJBController} from "../../../../src/interfaces/IJBController.sol";
+import {IJBDirectory} from "../../../../src/interfaces/IJBDirectory.sol";
+import {IJBFundAccessLimits} from "../../../../src/interfaces/IJBFundAccessLimits.sol";
+import {IJBRulesetApprovalHook} from "../../../../src/interfaces/IJBRulesetApprovalHook.sol";
+import {IJBRulesetDataHook} from "../../../../src/interfaces/IJBRulesetDataHook.sol";
+import {IJBRulesets} from "../../../../src/interfaces/IJBRulesets.sol";
+import {IJBTerminal} from "../../../../src/interfaces/IJBTerminal.sol";
+import {IJBToken} from "../../../../src/interfaces/IJBToken.sol";
+import {JBConstants} from "../../../../src/libraries/JBConstants.sol";
+import {JBRulesetMetadataResolver} from "../../../../src/libraries/JBRulesetMetadataResolver.sol";
+import {JBAccountingContext} from "../../../../src/structs/JBAccountingContext.sol";
+import {JBBeforeCashOutRecordedContext} from "../../../../src/structs/JBBeforeCashOutRecordedContext.sol";
+import {JBCashOutHookSpecification} from "../../../../src/structs/JBCashOutHookSpecification.sol";
+import {JBCurrencyAmount} from "../../../../src/structs/JBCurrencyAmount.sol";
+import {JBRuleset} from "../../../../src/structs/JBRuleset.sol";
+import {JBRulesetMetadata} from "../../../../src/structs/JBRulesetMetadata.sol";
+import {JBTokenAmount} from "../../../../src/structs/JBTokenAmount.sol";
+import {mulDiv} from "@prb/math/src/Common.sol";
 import {JBTerminalStoreSetup} from "./JBTerminalStoreSetup.sol";
 
 contract TestRecordCashOutsFor_Local is JBTerminalStoreSetup {
@@ -317,6 +336,7 @@ contract TestRecordCashOutsFor_Local is JBTerminalStoreSetup {
             cashOutCount: _cashOutCount,
             accountingContext: _accountingContexts,
             balanceAccountingContexts: _balanceContexts,
+            beneficiaryIsFeeless: false,
             metadata: ""
         });
     }
@@ -350,6 +370,7 @@ contract TestRecordCashOutsFor_Local is JBTerminalStoreSetup {
             cashOutCount: _cashOutCount,
             accountingContext: _accountingContexts,
             balanceAccountingContexts: _balanceContexts,
+            beneficiaryIsFeeless: false,
             metadata: ""
         });
 
@@ -401,6 +422,7 @@ contract TestRecordCashOutsFor_Local is JBTerminalStoreSetup {
             surplus: _reclaimedTokenAmount,
             useTotalSurplus: true,
             cashOutTaxRate: 0,
+            beneficiaryIsFeeless: false,
             metadata: ""
         });
 
@@ -423,6 +445,7 @@ contract TestRecordCashOutsFor_Local is JBTerminalStoreSetup {
             cashOutCount: _cashOutCount,
             accountingContext: _accountingContexts,
             balanceAccountingContexts: _balanceContexts,
+            beneficiaryIsFeeless: false,
             metadata: ""
         });
 
@@ -468,10 +491,78 @@ contract TestRecordCashOutsFor_Local is JBTerminalStoreSetup {
             cashOutCount: _cashOutCount,
             accountingContext: _accountingContexts,
             balanceAccountingContexts: _balanceContexts,
+            beneficiaryIsFeeless: false,
             metadata: ""
         });
     }
 
+    function test_GivenBeneficiaryIsFeeless_DataHookReceivesTrue()
+        external
+        whenCurrentRulesetUseTotalSurplusForCashOutsEqTrueWithHook
+    {
+        // it will pass beneficiaryIsFeeless=true through to the data hook context
+
+        // mock JBController totalTokenSupplyWithReservedTokensOf
+        mockExpect(
+            address(_controller),
+            abi.encodeCall(IJBController.totalTokenSupplyWithReservedTokensOf, (_projectId)),
+            abi.encode(_totalSupply)
+        );
+
+        // call params
+        JBAccountingContext memory _accountingContexts =
+            JBAccountingContext({token: address(_token), decimals: 18, currency: _currency});
+        JBAccountingContext[] memory _balanceContexts = new JBAccountingContext[](1);
+
+        _balanceContexts[0] = JBAccountingContext({token: address(_token), decimals: 18, currency: _currency});
+
+        uint256 _cashOutCount = 1e18;
+        uint256 expectedCashOuts = mulDiv(3e18, _cashOutCount, _totalSupply);
+
+        // Create the expected context — beneficiaryIsFeeless should be true.
+        JBBeforeCashOutRecordedContext memory _context = JBBeforeCashOutRecordedContext({
+            terminal: address(this),
+            holder: address(this),
+            projectId: _projectId,
+            rulesetId: uint48(block.timestamp),
+            cashOutCount: _cashOutCount,
+            totalSupply: _totalSupply,
+            surplus: JBTokenAmount({
+                token: _accountingContexts.token,
+                value: 3e18,
+                decimals: _accountingContexts.decimals,
+                currency: _accountingContexts.currency
+            }),
+            useTotalSurplus: true,
+            cashOutTaxRate: 0,
+            beneficiaryIsFeeless: true,
+            metadata: ""
+        });
+
+        // return data
+        JBCashOutHookSpecification[] memory _spec = new JBCashOutHookSpecification[](1);
+        _spec[0] = JBCashOutHookSpecification({hook: _cashOutHook, amount: 0, metadata: ""});
+
+        // The mock will only match if the context has beneficiaryIsFeeless=true.
+        mockExpect(
+            address(_dataHook),
+            abi.encodeCall(IJBRulesetDataHook.beforeCashOutRecordedWith, (_context)),
+            abi.encode(0, 1e18, _totalSupply, _spec)
+        );
+
+        (, uint256 reclaimed,,) = _store.recordCashOutFor({
+            holder: address(this),
+            projectId: _projectId,
+            cashOutCount: _cashOutCount,
+            accountingContext: _accountingContexts,
+            balanceAccountingContexts: _balanceContexts,
+            beneficiaryIsFeeless: true,
+            metadata: ""
+        });
+
+        assertEq(expectedCashOuts, reclaimed);
+    }
+
     // Probably unnecessary even though it may give us a bit of cov %.. skipping for now
     /* function test_WhenTheCurrentRulesetUseTotalSurplusForCashOutsEqFalse() external {
         // it will use the standard surplus calculation

package/test/units/static/JBTerminalStore/TestRecordPaymentFrom.sol

@@ -1,7 +1,21 @@
 // SPDX-License-Identifier: MIT
 pragma solidity 0.8.26;
 
-import /* {*} from */ "../../../helpers/TestBaseWorkflow.sol";
+import {JBTerminalStore} from "../../../../src/JBTerminalStore.sol";
+import {IJBPayHook} from "../../../../src/interfaces/IJBPayHook.sol";
+import {IJBPrices} from "../../../../src/interfaces/IJBPrices.sol";
+import {IJBRulesetApprovalHook} from "../../../../src/interfaces/IJBRulesetApprovalHook.sol";
+import {IJBRulesetDataHook} from "../../../../src/interfaces/IJBRulesetDataHook.sol";
+import {IJBRulesets} from "../../../../src/interfaces/IJBRulesets.sol";
+import {IJBToken} from "../../../../src/interfaces/IJBToken.sol";
+import {JBConstants} from "../../../../src/libraries/JBConstants.sol";
+import {JBRulesetMetadataResolver} from "../../../../src/libraries/JBRulesetMetadataResolver.sol";
+import {JBBeforePayRecordedContext} from "../../../../src/structs/JBBeforePayRecordedContext.sol";
+import {JBPayHookSpecification} from "../../../../src/structs/JBPayHookSpecification.sol";
+import {JBRuleset} from "../../../../src/structs/JBRuleset.sol";
+import {JBRulesetMetadata} from "../../../../src/structs/JBRulesetMetadata.sol";
+import {JBTokenAmount} from "../../../../src/structs/JBTokenAmount.sol";
+import {mulDiv} from "@prb/math/src/Common.sol";
 import {JBTerminalStoreSetup} from "./JBTerminalStoreSetup.sol";
 
 contract TestRecordPaymentFrom_Local is JBTerminalStoreSetup {

package/test/units/static/JBTerminalStore/TestRecordPayoutFor.sol

@@ -1,7 +1,19 @@
 // SPDX-License-Identifier: MIT
 pragma solidity 0.8.26;
 
-import /* {*} from */ "../../../helpers/TestBaseWorkflow.sol";
+import {JBTerminalStore} from "../../../../src/JBTerminalStore.sol";
+import {IJBController} from "../../../../src/interfaces/IJBController.sol";
+import {IJBDirectory} from "../../../../src/interfaces/IJBDirectory.sol";
+import {IJBFundAccessLimits} from "../../../../src/interfaces/IJBFundAccessLimits.sol";
+import {IJBPrices} from "../../../../src/interfaces/IJBPrices.sol";
+import {IJBRulesetApprovalHook} from "../../../../src/interfaces/IJBRulesetApprovalHook.sol";
+import {IJBRulesets} from "../../../../src/interfaces/IJBRulesets.sol";
+import {IJBToken} from "../../../../src/interfaces/IJBToken.sol";
+import {JBConstants} from "../../../../src/libraries/JBConstants.sol";
+import {JBRulesetMetadataResolver} from "../../../../src/libraries/JBRulesetMetadataResolver.sol";
+import {JBAccountingContext} from "../../../../src/structs/JBAccountingContext.sol";
+import {JBRuleset} from "../../../../src/structs/JBRuleset.sol";
+import {JBRulesetMetadata} from "../../../../src/structs/JBRulesetMetadata.sol";
 import {JBTerminalStoreSetup} from "./JBTerminalStoreSetup.sol";
 
 contract TestRecordPayoutFor_Local is JBTerminalStoreSetup {

package/test/units/static/JBTerminalStore/TestRecordTerminalMigration.sol

@@ -1,7 +1,14 @@
 // SPDX-License-Identifier: MIT
 pragma solidity 0.8.26;
 
-import /* {*} from */ "../../../helpers/TestBaseWorkflow.sol";
+import {JBTerminalStore} from "../../../../src/JBTerminalStore.sol";
+import {IJBRulesetApprovalHook} from "../../../../src/interfaces/IJBRulesetApprovalHook.sol";
+import {IJBRulesets} from "../../../../src/interfaces/IJBRulesets.sol";
+import {IJBToken} from "../../../../src/interfaces/IJBToken.sol";
+import {JBConstants} from "../../../../src/libraries/JBConstants.sol";
+import {JBRulesetMetadataResolver} from "../../../../src/libraries/JBRulesetMetadataResolver.sol";
+import {JBRuleset} from "../../../../src/structs/JBRuleset.sol";
+import {JBRulesetMetadata} from "../../../../src/structs/JBRulesetMetadata.sol";
 import {JBTerminalStoreSetup} from "./JBTerminalStoreSetup.sol";
 
 contract TestRecordTerminalMigration_Local is JBTerminalStoreSetup {

package/test/units/static/JBTerminalStore/TestRecordUsedAllowanceOf.sol

@@ -1,7 +1,20 @@
 // SPDX-License-Identifier: MIT
 pragma solidity 0.8.26;
 
-import /* {*} from */ "../../../helpers/TestBaseWorkflow.sol";
+import {JBTerminalStore} from "../../../../src/JBTerminalStore.sol";
+import {IJBController} from "../../../../src/interfaces/IJBController.sol";
+import {IJBDirectory} from "../../../../src/interfaces/IJBDirectory.sol";
+import {IJBFundAccessLimits} from "../../../../src/interfaces/IJBFundAccessLimits.sol";
+import {IJBPrices} from "../../../../src/interfaces/IJBPrices.sol";
+import {IJBRulesetApprovalHook} from "../../../../src/interfaces/IJBRulesetApprovalHook.sol";
+import {IJBRulesets} from "../../../../src/interfaces/IJBRulesets.sol";
+import {IJBToken} from "../../../../src/interfaces/IJBToken.sol";
+import {JBConstants} from "../../../../src/libraries/JBConstants.sol";
+import {JBRulesetMetadataResolver} from "../../../../src/libraries/JBRulesetMetadataResolver.sol";
+import {JBAccountingContext} from "../../../../src/structs/JBAccountingContext.sol";
+import {JBCurrencyAmount} from "../../../../src/structs/JBCurrencyAmount.sol";
+import {JBRuleset} from "../../../../src/structs/JBRuleset.sol";
+import {JBRulesetMetadata} from "../../../../src/structs/JBRulesetMetadata.sol";
 import {JBTerminalStoreSetup} from "./JBTerminalStoreSetup.sol";
 
 contract TestRecordUsedAllowanceOf_Local is JBTerminalStoreSetup {
@@ -42,6 +55,7 @@ contract TestRecordUsedAllowanceOf_Local is JBTerminalStoreSetup {
         JBRulesetMetadata memory _metadata = JBRulesetMetadata({
             reservedPercent: 0,
             cashOutTaxRate: JBConstants.MAX_CASH_OUT_TAX_RATE,
+            // forge-lint: disable-next-line(unsafe-typecast)
             baseCurrency: uint32(uint160(_nativeAddress)),
             pausePay: false,
             pauseCreditTransfers: false,
@@ -144,6 +158,7 @@ contract TestRecordUsedAllowanceOf_Local is JBTerminalStoreSetup {
         JBRulesetMetadata memory _metadata = JBRulesetMetadata({
             reservedPercent: 0,
             cashOutTaxRate: JBConstants.MAX_CASH_OUT_TAX_RATE,
+            // forge-lint: disable-next-line(unsafe-typecast)
             baseCurrency: uint32(uint160(_nativeAddress)),
             pausePay: false,
             pauseCreditTransfers: false,

package/test/units/static/JBTerminalStore/TestUint224Overflow.sol

@@ -1,7 +1,21 @@
 // SPDX-License-Identifier: MIT
 pragma solidity 0.8.26;
 
-import /* {*} from */ "../../../helpers/TestBaseWorkflow.sol";
+import {JBTerminalStore} from "../../../../src/JBTerminalStore.sol";
+import {IJBController} from "../../../../src/interfaces/IJBController.sol";
+import {IJBDirectory} from "../../../../src/interfaces/IJBDirectory.sol";
+import {IJBFundAccessLimits} from "../../../../src/interfaces/IJBFundAccessLimits.sol";
+import {IJBPrices} from "../../../../src/interfaces/IJBPrices.sol";
+import {IJBRulesetApprovalHook} from "../../../../src/interfaces/IJBRulesetApprovalHook.sol";
+import {IJBRulesets} from "../../../../src/interfaces/IJBRulesets.sol";
+import {IJBTerminal} from "../../../../src/interfaces/IJBTerminal.sol";
+import {IJBToken} from "../../../../src/interfaces/IJBToken.sol";
+import {JBConstants} from "../../../../src/libraries/JBConstants.sol";
+import {JBRulesetMetadataResolver} from "../../../../src/libraries/JBRulesetMetadataResolver.sol";
+import {JBAccountingContext} from "../../../../src/structs/JBAccountingContext.sol";
+import {JBCurrencyAmount} from "../../../../src/structs/JBCurrencyAmount.sol";
+import {JBRuleset} from "../../../../src/structs/JBRuleset.sol";
+import {JBRulesetMetadata} from "../../../../src/structs/JBRulesetMetadata.sol";
 import {JBTerminalStoreSetup} from "./JBTerminalStoreSetup.sol";
 
 contract TestUint224Overflow_Local is JBTerminalStoreSetup {

package/test/units/static/JBTokens/JBTokensSetup.sol

@@ -1,7 +1,11 @@
 // SPDX-License-Identifier: MIT
 pragma solidity 0.8.26;
 
-import /* {*} from */ "../../../helpers/TestBaseWorkflow.sol";
+import {JBERC20} from "../../../../src/JBERC20.sol";
+import {JBTokens} from "../../../../src/JBTokens.sol";
+import {IJBDirectory} from "../../../../src/interfaces/IJBDirectory.sol";
+import {IJBToken} from "../../../../src/interfaces/IJBToken.sol";
+import {IJBTokens} from "../../../../src/interfaces/IJBTokens.sol";
 import {JBTest} from "../../../helpers/JBTest.sol";
 
 /*

package/test/units/static/JBTokens/TestBurnFrom.sol

@@ -1,7 +1,10 @@
 // SPDX-License-Identifier: MIT
 pragma solidity 0.8.26;
 
-import /* {*} from */ "../../../helpers/TestBaseWorkflow.sol";
+import {JBTokens} from "../../../../src/JBTokens.sol";
+import {JBControlled} from "../../../../src/abstract/JBControlled.sol";
+import {IJBDirectory} from "../../../../src/interfaces/IJBDirectory.sol";
+import {IJBToken} from "../../../../src/interfaces/IJBToken.sol";
 import {JBTokensSetup} from "./JBTokensSetup.sol";
 
 contract TestBurnFrom_Local is JBTokensSetup {

package/test/units/static/JBTokens/TestClaimTokensFor.sol

@@ -1,7 +1,10 @@
 // SPDX-License-Identifier: MIT
 pragma solidity 0.8.26;
 
-import /* {*} from */ "../../../helpers/TestBaseWorkflow.sol";
+import {JBTokens} from "../../../../src/JBTokens.sol";
+import {JBControlled} from "../../../../src/abstract/JBControlled.sol";
+import {IJBDirectory} from "../../../../src/interfaces/IJBDirectory.sol";
+import {IJBToken} from "../../../../src/interfaces/IJBToken.sol";
 import {JBTokensSetup} from "./JBTokensSetup.sol";
 
 contract TestClaimTokensFor_Local is JBTokensSetup {

package/test/units/static/JBTokens/TestDeployERC20ForUnits.sol

@@ -1,7 +1,10 @@
 // SPDX-License-Identifier: MIT
 pragma solidity 0.8.26;
 
-import /* {*} from */ "../../../helpers/TestBaseWorkflow.sol";
+import {JBTokens} from "../../../../src/JBTokens.sol";
+import {IJBDirectory} from "../../../../src/interfaces/IJBDirectory.sol";
+import {IJBToken} from "../../../../src/interfaces/IJBToken.sol";
+import {IJBTokens} from "../../../../src/interfaces/IJBTokens.sol";
 import {JBTokensSetup} from "./JBTokensSetup.sol";
 import {Clones} from "@openzeppelin/contracts/proxy/Clones.sol";
 

package/test/units/static/JBTokens/TestMintFor.sol

@@ -1,7 +1,10 @@
 // SPDX-License-Identifier: MIT
 pragma solidity 0.8.26;
 
-import /* {*} from */ "../../../helpers/TestBaseWorkflow.sol";
+import {JBTokens} from "../../../../src/JBTokens.sol";
+import {JBControlled} from "../../../../src/abstract/JBControlled.sol";
+import {IJBDirectory} from "../../../../src/interfaces/IJBDirectory.sol";
+import {IJBToken} from "../../../../src/interfaces/IJBToken.sol";
 import {JBTokensSetup} from "./JBTokensSetup.sol";
 
 contract TestMintFor_Local is JBTokensSetup {

package/test/units/static/JBTokens/TestSetTokenFor.sol

@@ -1,7 +1,10 @@
 // SPDX-License-Identifier: MIT
 pragma solidity 0.8.26;
 
-import /* {*} from */ "../../../helpers/TestBaseWorkflow.sol";
+import {JBTokens} from "../../../../src/JBTokens.sol";
+import {IJBDirectory} from "../../../../src/interfaces/IJBDirectory.sol";
+import {IJBToken} from "../../../../src/interfaces/IJBToken.sol";
+import {IJBTokens} from "../../../../src/interfaces/IJBTokens.sol";
 import {JBTokensSetup} from "./JBTokensSetup.sol";
 
 contract TestSetTokenFor_Local is JBTokensSetup {

package/test/units/static/JBTokens/TestTotalBalanceOf.sol

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: MIT
 pragma solidity 0.8.26;
 
-import /* {*} from */ "../../../helpers/TestBaseWorkflow.sol";
+import {IJBToken} from "../../../../src/interfaces/IJBToken.sol";
 import {JBTokensSetup} from "./JBTokensSetup.sol";
 
 contract TestTotalBalanceOf_Local is JBTokensSetup {

package/test/units/static/JBTokens/TestTotalSupplyOf.sol

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: MIT
 pragma solidity 0.8.26;
 
-import /* {*} from */ "../../../helpers/TestBaseWorkflow.sol";
+import {IJBToken} from "../../../../src/interfaces/IJBToken.sol";
 import {JBTokensSetup} from "./JBTokensSetup.sol";
 
 contract TestTotalSupplyOf_Local is JBTokensSetup {

package/test/units/static/JBTokens/TestTransferCreditsFrom.sol

@@ -1,7 +1,9 @@
 // SPDX-License-Identifier: MIT
 pragma solidity 0.8.26;
 
-import /* {*} from */ "../../../helpers/TestBaseWorkflow.sol";
+import {JBTokens} from "../../../../src/JBTokens.sol";
+import {IJBDirectory} from "../../../../src/interfaces/IJBDirectory.sol";
+import {IJBTokens} from "../../../../src/interfaces/IJBTokens.sol";
 import {JBTokensSetup} from "./JBTokensSetup.sol";
 
 contract TestTransferCreditsFrom_Local is JBTokensSetup {