@bananapus/core-v6 0.0.19 → 0.0.21

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

@@ -133,7 +133,6 @@ contract TestPreviewCashOutFor_Local is JBTerminalStoreSetup {
         );
 
         (, uint256 previewReclaimAmount, uint256 previewTaxRate, JBCashOutHookSpecification[] memory previewSpecs) = _store.previewCashOutFrom({
-            terminal: address(this),
             holder: address(this),
             projectId: _projectId,
             cashOutCount: _cashOutCount,
@@ -222,7 +221,6 @@ contract TestPreviewCashOutFor_Local is JBTerminalStoreSetup {
         uint256 balanceBefore = _store.balanceOf(address(this), _projectId, address(_token));
 
         _store.previewCashOutFrom({
-            terminal: address(this),
             holder: address(this),
             projectId: _projectId,
             cashOutCount: 5e18,
@@ -295,7 +293,6 @@ contract TestPreviewCashOutFor_Local is JBTerminalStoreSetup {
             )
         );
         _store.previewCashOutFrom({
-            terminal: address(this),
             holder: address(this),
             projectId: _projectId,
             cashOutCount: _excessiveCashOutCount,
@@ -368,7 +365,6 @@ contract TestPreviewCashOutFor_Local is JBTerminalStoreSetup {
         );
 
         (, uint256 reclaimAmount,,) = _store.previewCashOutFrom({
-            terminal: address(this),
             holder: address(this),
             projectId: _projectId,
             cashOutCount: 5e18,
@@ -380,4 +376,100 @@ contract TestPreviewCashOutFor_Local is JBTerminalStoreSetup {
 
         assertEq(reclaimAmount, 0);
     }
+
+    function test_WithDataHookAndZeroAmountNoopSpec() external {
+        _setBalance(address(this), _balance);
+        _mockUseTotalSurplus();
+
+        JBRulesetMetadata memory _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: true,
+            useDataHookForPay: false,
+            useDataHookForCashOut: true,
+            dataHook: address(_dataHook),
+            metadata: 0
+        });
+
+        uint256 _packedMetadata = JBRulesetMetadataResolver.packRulesetMetadata(_metadata);
+
+        JBRuleset memory _returnedRuleset = JBRuleset({
+            cycleNumber: uint48(block.timestamp),
+            id: uint48(block.timestamp),
+            basedOnId: 0,
+            start: uint48(block.timestamp),
+            duration: uint32(block.timestamp + 1000),
+            weight: 1e18,
+            weightCutPercent: 0,
+            approvalHook: IJBRulesetApprovalHook(address(0)),
+            metadata: _packedMetadata
+        });
+
+        JBAccountingContext memory _accountingContext =
+            JBAccountingContext({token: address(_token), decimals: uint8(_decimals), currency: _currency});
+
+        JBBeforeCashOutRecordedContext memory _context = JBBeforeCashOutRecordedContext({
+            terminal: address(this),
+            holder: address(this),
+            projectId: _projectId,
+            rulesetId: uint48(block.timestamp),
+            cashOutCount: 10e18,
+            totalSupply: _totalSupply,
+            surplus: JBTokenAmount({
+                token: _accountingContext.token,
+                value: 3e18,
+                decimals: _accountingContext.decimals,
+                currency: _accountingContext.currency
+            }),
+            useTotalSurplus: true,
+            cashOutTaxRate: 0,
+            beneficiaryIsFeeless: false,
+            metadata: ""
+        });
+
+        JBCashOutHookSpecification[] memory _spec = new JBCashOutHookSpecification[](1);
+        _spec[0] = JBCashOutHookSpecification({hook: _cashOutHook, noop: true, amount: 0, metadata: "info"});
+
+        mockExpect(address(rulesets), abi.encodeCall(IJBRulesets.currentOf, (_projectId)), abi.encode(_returnedRuleset));
+        mockExpect(address(directory), abi.encodeCall(IJBDirectory.controllerOf, (_projectId)), abi.encode(_controller));
+        mockExpect(
+            address(_controller),
+            abi.encodeCall(IJBController.totalTokenSupplyWithReservedTokensOf, (_projectId)),
+            abi.encode(_totalSupply)
+        );
+        mockExpect(
+            address(_dataHook),
+            abi.encodeCall(IJBRulesetDataHook.beforeCashOutRecordedWith, (_context)),
+            abi.encode(0, 10e18, _totalSupply, _spec)
+        );
+
+        (, uint256 reclaimAmount, uint256 cashOutTaxRate, JBCashOutHookSpecification[] memory hookSpecifications) = _store.previewCashOutFrom({
+            holder: address(this),
+            projectId: _projectId,
+            cashOutCount: 10e18,
+            accountingContext: _accountingContext,
+            balanceAccountingContexts: new JBAccountingContext[](0),
+            beneficiaryIsFeeless: false,
+            metadata: ""
+        });
+
+        assertEq(reclaimAmount, mulDiv(3e18, 10e18, _totalSupply));
+        assertEq(cashOutTaxRate, 0);
+        assertEq(hookSpecifications.length, 1);
+        assertEq(hookSpecifications[0].amount, 0);
+        assertEq(hookSpecifications[0].noop, true);
+        assertEq(hookSpecifications[0].metadata, bytes("info"));
+    }
 }

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

@@ -60,13 +60,9 @@ contract TestPreviewPayFrom_Local is JBTerminalStoreSetup {
         mockExpect(address(rulesets), abi.encodeCall(IJBRulesets.currentOf, (_projectId)), abi.encode(_returnedRuleset));
 
         vm.expectRevert(abi.encodeWithSelector(JBTerminalStore.JBTerminalStore_RulesetNotFound.selector, _projectId));
+        vm.prank(_terminal);
         _store.previewPayFrom({
-            terminal: _terminal,
-            payer: address(this),
-            amount: _tokenAmount,
-            projectId: _projectId,
-            beneficiary: address(this),
-            metadata: ""
+            payer: address(this), amount: _tokenAmount, projectId: _projectId, beneficiary: address(this), metadata: ""
         });
     }
 
@@ -116,13 +112,9 @@ contract TestPreviewPayFrom_Local is JBTerminalStoreSetup {
         mockExpect(address(rulesets), abi.encodeCall(IJBRulesets.currentOf, (_projectId)), abi.encode(_returnedRuleset));
 
         vm.expectRevert(JBTerminalStore.JBTerminalStore_RulesetPaymentPaused.selector);
+        vm.prank(_terminal);
         _store.previewPayFrom({
-            terminal: _terminal,
-            payer: address(this),
-            amount: _tokenAmount,
-            projectId: _projectId,
-            beneficiary: address(this),
-            metadata: ""
+            payer: address(this), amount: _tokenAmount, projectId: _projectId, beneficiary: address(this), metadata: ""
         });
     }
 
@@ -173,12 +165,7 @@ contract TestPreviewPayFrom_Local is JBTerminalStoreSetup {
         mockExpect(address(rulesets), abi.encodeCall(IJBRulesets.currentOf, (_projectId)), abi.encode(_returnedRuleset));
 
         (, uint256 previewTokenCount, JBPayHookSpecification[] memory previewSpecs) = _store.previewPayFrom({
-            terminal: address(this),
-            payer: address(this),
-            amount: _tokenAmount,
-            projectId: _projectId,
-            beneficiary: address(this),
-            metadata: ""
+            payer: address(this), amount: _tokenAmount, projectId: _projectId, beneficiary: address(this), metadata: ""
         });
 
         // Mock for record call
@@ -236,7 +223,7 @@ contract TestPreviewPayFrom_Local is JBTerminalStoreSetup {
         });
 
         JBPayHookSpecification[] memory _spec = new JBPayHookSpecification[](1);
-        _spec[0] = JBPayHookSpecification({hook: _payHook, amount: _defaultValue / 2, metadata: ""});
+        _spec[0] = JBPayHookSpecification({hook: _payHook, noop: false, amount: _defaultValue / 2, metadata: ""});
 
         // The data hook context will use the terminal address passed to preview / msg.sender for record.
         // Since we call both from address(this), they match.
@@ -261,12 +248,7 @@ contract TestPreviewPayFrom_Local is JBTerminalStoreSetup {
         );
 
         (, uint256 previewTokenCount, JBPayHookSpecification[] memory previewSpecs) = _store.previewPayFrom({
-            terminal: address(this),
-            payer: address(this),
-            amount: _tokenAmount,
-            projectId: _projectId,
-            beneficiary: address(this),
-            metadata: ""
+            payer: address(this), amount: _tokenAmount, projectId: _projectId, beneficiary: address(this), metadata: ""
         });
 
         // Mock for record call
@@ -333,13 +315,9 @@ contract TestPreviewPayFrom_Local is JBTerminalStoreSetup {
 
         uint256 balanceBefore = _store.balanceOf(_terminal, _projectId, address(_token));
 
+        vm.prank(_terminal);
         _store.previewPayFrom({
-            terminal: _terminal,
-            payer: address(this),
-            amount: _tokenAmount,
-            projectId: _projectId,
-            beneficiary: address(this),
-            metadata: ""
+            payer: address(this), amount: _tokenAmount, projectId: _projectId, beneficiary: address(this), metadata: ""
         });
 
         uint256 balanceAfter = _store.balanceOf(_terminal, _projectId, address(_token));
@@ -401,15 +379,86 @@ contract TestPreviewPayFrom_Local is JBTerminalStoreSetup {
 
         uint256 expectedCount = mulDiv(_defaultValue, 1e18, 2e18);
 
+        vm.prank(_terminal);
         (, uint256 tokenCount,) = _store.previewPayFrom({
+            payer: address(this), amount: _tokenAmount, projectId: _projectId, beneficiary: address(this), metadata: ""
+        });
+
+        assertEq(tokenCount, expectedCount);
+    }
+
+    function test_WithDataHookAndZeroAmountNoopSpec() external {
+        JBTokenAmount memory _tokenAmount = JBTokenAmount({
+            token: address(_token), value: _defaultValue, decimals: _defaultDecimals, currency: _currency
+        });
+
+        JBRulesetMetadata memory _metadata = JBRulesetMetadata({
+            reservedPercent: 0,
+            cashOutTaxRate: JBConstants.MAX_CASH_OUT_TAX_RATE,
+            baseCurrency: uint32(uint160(address(_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: true,
+            useDataHookForCashOut: false,
+            dataHook: address(_dataHook),
+            metadata: 0
+        });
+
+        uint256 _packedMetadata = JBRulesetMetadataResolver.packRulesetMetadata(_metadata);
+
+        JBRuleset memory _returnedRuleset = JBRuleset({
+            cycleNumber: uint48(block.timestamp),
+            id: uint48(block.timestamp),
+            basedOnId: 0,
+            start: uint48(block.timestamp),
+            duration: uint32(block.timestamp + 1000),
+            weight: 1e18,
+            weightCutPercent: 0,
+            approvalHook: IJBRulesetApprovalHook(address(0)),
+            metadata: _packedMetadata
+        });
+
+        JBPayHookSpecification[] memory _spec = new JBPayHookSpecification[](1);
+        _spec[0] = JBPayHookSpecification({hook: _payHook, noop: true, amount: 0, metadata: "info"});
+
+        JBBeforePayRecordedContext memory _context = JBBeforePayRecordedContext({
             terminal: _terminal,
             payer: address(this),
             amount: _tokenAmount,
             projectId: _projectId,
+            rulesetId: uint48(block.timestamp),
             beneficiary: address(this),
+            weight: _returnedRuleset.weight,
+            reservedPercent: _returnedRuleset.reservedPercent(),
             metadata: ""
         });
 
-        assertEq(tokenCount, expectedCount);
+        mockExpect(address(rulesets), abi.encodeCall(IJBRulesets.currentOf, (_projectId)), abi.encode(_returnedRuleset));
+        mockExpect(
+            address(_dataHook),
+            abi.encodeCall(IJBRulesetDataHook.beforePayRecordedWith, (_context)),
+            abi.encode(1e18 / 2, _spec)
+        );
+
+        vm.prank(_terminal);
+        (, uint256 tokenCount, JBPayHookSpecification[] memory hookSpecifications) = _store.previewPayFrom({
+            payer: address(this), amount: _tokenAmount, projectId: _projectId, beneficiary: address(this), metadata: ""
+        });
+
+        assertEq(tokenCount, 1e18 / 2);
+        assertEq(hookSpecifications.length, 1);
+        assertEq(hookSpecifications[0].amount, 0);
+        assertEq(hookSpecifications[0].noop, true);
+        assertEq(hookSpecifications[0].metadata, bytes("info"));
     }
 }

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

@@ -428,7 +428,7 @@ contract TestRecordCashOutsFor_Local is JBTerminalStoreSetup {
 
         // return data
         JBCashOutHookSpecification[] memory _spec = new JBCashOutHookSpecification[](1);
-        _spec[0] = JBCashOutHookSpecification({hook: _cashOutHook, amount: 0, metadata: ""});
+        _spec[0] = JBCashOutHookSpecification({hook: _cashOutHook, noop: false, amount: 0, metadata: ""});
 
         // mock call to data hook beforeCashOutRecordedWith
         mockExpect(
@@ -541,7 +541,7 @@ contract TestRecordCashOutsFor_Local is JBTerminalStoreSetup {
 
         // return data
         JBCashOutHookSpecification[] memory _spec = new JBCashOutHookSpecification[](1);
-        _spec[0] = JBCashOutHookSpecification({hook: _cashOutHook, amount: 0, metadata: ""});
+        _spec[0] = JBCashOutHookSpecification({hook: _cashOutHook, noop: false, amount: 0, metadata: ""});
 
         // The mock will only match if the context has beneficiaryIsFeeless=true.
         mockExpect(
@@ -563,6 +563,117 @@ contract TestRecordCashOutsFor_Local is JBTerminalStoreSetup {
         assertEq(expectedCashOuts, reclaimed);
     }
 
+    function test_GivenTheHookReturnsANoopSpecWithAmount()
+        external
+        whenCurrentRulesetUseTotalSurplusForCashOutsEqTrueWithHook
+    {
+        mockExpect(
+            address(_controller),
+            abi.encodeCall(IJBController.totalTokenSupplyWithReservedTokensOf, (_projectId)),
+            abi.encode(_totalSupply)
+        );
+
+        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});
+
+        JBBeforeCashOutRecordedContext memory _context = JBBeforeCashOutRecordedContext({
+            terminal: address(this),
+            holder: address(this),
+            projectId: _projectId,
+            rulesetId: uint48(block.timestamp),
+            cashOutCount: 1e18,
+            totalSupply: _totalSupply,
+            surplus: JBTokenAmount({
+                token: _accountingContexts.token,
+                value: 3e18,
+                decimals: _accountingContexts.decimals,
+                currency: _accountingContexts.currency
+            }),
+            useTotalSurplus: true,
+            cashOutTaxRate: 0,
+            beneficiaryIsFeeless: false,
+            metadata: ""
+        });
+
+        JBCashOutHookSpecification[] memory _spec = new JBCashOutHookSpecification[](1);
+        _spec[0] = JBCashOutHookSpecification({hook: _cashOutHook, noop: true, amount: 1, metadata: ""});
+
+        mockExpect(
+            address(_dataHook),
+            abi.encodeCall(IJBRulesetDataHook.beforeCashOutRecordedWith, (_context)),
+            abi.encode(0, 1e18, _totalSupply, _spec)
+        );
+
+        vm.expectRevert(abi.encodeWithSelector(JBTerminalStore.JBTerminalStore_NoopHookSpecHasAmount.selector, 1));
+        _store.recordCashOutFor({
+            holder: address(this),
+            projectId: _projectId,
+            cashOutCount: 1e18,
+            accountingContext: _accountingContexts,
+            balanceAccountingContexts: _balanceContexts,
+            beneficiaryIsFeeless: false,
+            metadata: ""
+        });
+    }
+
+    function test_GivenALaterHookReturnsANoopSpecWithAmount()
+        external
+        whenCurrentRulesetUseTotalSurplusForCashOutsEqTrueWithHook
+    {
+        mockExpect(
+            address(_controller),
+            abi.encodeCall(IJBController.totalTokenSupplyWithReservedTokensOf, (_projectId)),
+            abi.encode(_totalSupply)
+        );
+
+        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});
+
+        JBBeforeCashOutRecordedContext memory _context = JBBeforeCashOutRecordedContext({
+            terminal: address(this),
+            holder: address(this),
+            projectId: _projectId,
+            rulesetId: uint48(block.timestamp),
+            cashOutCount: 1e18,
+            totalSupply: _totalSupply,
+            surplus: JBTokenAmount({
+                token: _accountingContexts.token,
+                value: 3e18,
+                decimals: _accountingContexts.decimals,
+                currency: _accountingContexts.currency
+            }),
+            useTotalSurplus: true,
+            cashOutTaxRate: 0,
+            beneficiaryIsFeeless: false,
+            metadata: ""
+        });
+
+        JBCashOutHookSpecification[] memory _spec = new JBCashOutHookSpecification[](2);
+        _spec[0] = JBCashOutHookSpecification({hook: _cashOutHook, noop: false, amount: 0, metadata: ""});
+        _spec[1] = JBCashOutHookSpecification({hook: _cashOutHook, noop: true, amount: 1, metadata: ""});
+
+        mockExpect(
+            address(_dataHook),
+            abi.encodeCall(IJBRulesetDataHook.beforeCashOutRecordedWith, (_context)),
+            abi.encode(0, 1e18, _totalSupply, _spec)
+        );
+
+        vm.expectRevert(abi.encodeWithSelector(JBTerminalStore.JBTerminalStore_NoopHookSpecHasAmount.selector, 1));
+        _store.recordCashOutFor({
+            holder: address(this),
+            projectId: _projectId,
+            cashOutCount: 1e18,
+            accountingContext: _accountingContexts,
+            balanceAccountingContexts: _balanceContexts,
+            beneficiaryIsFeeless: false,
+            metadata: ""
+        });
+    }
+
     // 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